مرجع API
Live — v1 available now

REST API

قم بتفعيل مكالمات الصوت AI، مزامنة جهات الاتصال، وقراءة نتائج المكالمات من أي خلفية، أو CRM، أو أداة بدون كود.

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

Authentication

Generate an API key from Dashboard → Settings → API Keys. مررها كرمز Bearer في كل طلب.

Authorization: Bearer oc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

المفاتيح مشفرة في حالة السكون وتظهرonly onceعند الإنشاء. قم بتدوير أو إلغاء التفويض في أي وقت من نفس صفحة الإعدادات.

ما يمكنك توصيله

واجهة برمجة التطبيقات هي REST بسيطة + رمز Bearer، لذا فهي تعمل مع أي شيء يتحدث HTTPS - لا حاجة إلى SDK.

Zapier

Webhooks + HTTP

تفعيل المكالمات عند إضافة عميل جديد إلى CRM الخاص بك، أو جدول بيانات، أو نموذج.

Make (Integromat)

وحدة HTTP

بناء سير عمل بصري: نموذج → OutboundCalls → تحديث Slack/البريد الإلكتروني/CRM.

n8n

عقدة طلب HTTP

أتمتة مستضافة ذاتيًا. قم بتوصيل قاعدة بياناتك، أو جدولة، أو مجموعة رسائل.

HubSpot / Salesforce / Pipedrive

CRM

ادفع جهات الاتصال الجديدة إلى حملة تلقائيًا؛ استرجع ملخصات المكالمات كسجلات نشاط.

الخلفية المخصصة (Node، Python، PHP، Go، Ruby)

أي لغة

REST القياسي + رمز Bearer. يعمل مع أي شيء يمكنه إجراء مكالمة HTTPS.

منصات بدون كود (Bubble، Retool، أتمتة Airtable)

بدون كود

قم بتوصيل نقطة النهاية في إجراء سير العمل - لا حاجة إلى SDK.

سير عمل حقيقية يمكنك بناؤها

عميل جديد يملأ نموذج 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 الخاص بك → وكيل الذكاء الاصطناعي يتصل بكل جهة خلال ساعات العمل
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 بإرسال حمولة 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 دقائق.