תיעוד API
Live — v1 available now

REST API

הפעילו שיחות קוליות מבוססות AI, סנכרנו אנשי קשר וקראו תוצאות שיחה מכל backend, CRM או כלי No-code.

Base URL:https://outboundcalls.ai/api/v1

Authentication

Generate an API key from Dashboard → Settings → API Keys. העבירו אותו כטוקן Bearer בכל בקשה.

Authorization: Bearer oc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

המפתחות נשמרים כ-hash בעת אחסון ומוצגיםonly onceבעת היצירה. ניתן להחליף או לבטל בכל עת מאותו עמוד הגדרות.

מה אפשר לחבר

ה-API הוא REST פשוט + טוקן Bearer, ולכן הוא עובד עם כל מערכת שיודעת לבצע קריאות HTTPS — ללא צורך ב-SDK.

Zapier

Webhook-ים + HTTP

הפעילו שיחות כאשר lead חדש נוסף ל-CRM, לגיליון האלקטרוני או לטופס שלכם.

Make (Integromat)

מודול HTTP

בנו תהליכי עבודה ויזואליים: טופס → OutboundCalls → עדכון ב-Slack/דוא״ל/CRM.

n8n

צומת בקשת HTTP

אוטומציה באירוח עצמי. חברו את מסד הנתונים, המתזמן או מערך ההודעות שלכם.

HubSpot / Salesforce / Pipedrive

CRM

העבירו אנשי קשר חדשים לקמפיין באופן אוטומטי; משכו בחזרה סיכומי שיחות כרשומות פעילות.

Backend מותאם אישית (Node, Python, PHP, Go, Ruby)

כל שפה

REST סטנדרטי + טוקן Bearer. עובד עם כל דבר שיודע לבצע קריאת HTTPS.

פלטפורמות No-code (Bubble, Retool, Airtable Automations)

No-code

חברו את נקודת הקצה לפעולה בתהליך עבודה — ללא צורך ב-SDK.

תהליכי עבודה אמיתיים שתוכלו לבנות

lead חדש ממלא את טופס ה-Typeform שלכם → מתקשרים אליו בתוך 30 שניות
Booking confirmation in Calendly → AI agent calls 24h before to confirm
Failed Stripe payment → reminder call instead of just an email
העלאת CSV יומית מה-CRM שלכם → סוכן AI מתקשר לכל איש קשר בשעות העבודה
WhatsApp inbound message → callback from voice agent if requested
התקדמות קמפיין ארוך טווח מסתנכרנת למחסן הנתונים שלכם כל 15 דקות

Endpoints

חשבון

GET/me

סוכנים

GET/agents
GET/agents/:id

אנשי קשר

GET/contacts
POST/contacts

שיחות

POST/calls
GET/calls
GET/calls/:id

קמפיינים

GET/campaigns
GET/campaigns/:id

נקודות קצה נוספות (יצירה/עדכון/מחיקה של סוכנים, ייבוא CSV, ניהול קמפיינים) נמצאות במפת הדרכים. צריכים אחת בדחיפות?Tell us.

Code examples

cURL
# Trigger an outbound call from your agent
curl -X POST https://outboundcalls.ai/api/v1/calls \
  -H "Authorization: Bearer oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "clxAGENT123",
    "toNumber": "+14155551212",
    "contactId": "clxCONTACT456"
  }'

# Response
{
  "id": "clxCALL789",
  "phoneFrom": "+12025550100",
  "phoneTo": "+14155551212",
  "status": "RINGING",
  "elevenlabsConvId": "conv_abc...",
  "createdAt": "2026-04-29T10:32:11.000Z"
}
JavaScript / Node.js
// Trigger a call from any Node.js / browser app
const r = await fetch('https://outboundcalls.ai/api/v1/calls', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.OC_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    agentId: 'clxAGENT123',
    toNumber: '+14155551212',
  }),
});
const call = await r.json();
console.log(call.id, call.status); // RINGING

// Later — fetch transcript & summary
const detail = await fetch(`https://outboundcalls.ai/api/v1/calls/${call.id}`, {
  headers: { Authorization: `Bearer ${process.env.OC_API_KEY}` },
}).then(r => r.json());
console.log(detail.summary, detail.transcript);

Post-call webhook

הגדירו כתובת URL של webhook לכל סוכן. לאחר כל שיחה, OutboundCalls מבצעת POST של מטען JSON חתום אל נקודת הקצה שלכם, הכולל:

  • Full transcript
  • Recording URL
  • AI-generated summary
  • Sentiment score
  • Goal achieved (true/false)
  • Extracted data fields
  • Duration + credits charged
  • Voicemail flag

כל מטעני הנתונים חתומים באמצעות HMAC-SHA256. אמתו את הכותרת מול סוד ה-webhook של הסוכן שלכם.

עולים לאוויר בדקות, לא בשבועות

צרו חשבון, צרו מפתח API והפעילו את השיחה הראשונה שלכם בפחות מ-5 דקות.