توثيق واجهة برمجة التطبيقات

المصادقة

تتطلب جميع طلبات واجهة برمجة التطبيقات مصادقة. يجب عليك تضمين مفتاح واجهة برمجة التطبيقات الخاص بك في رأس التفويض كرمز حامل.

Authorization: Bearer مفتاحك_الخاص

احتفظ بمفاتيحك آمنة. لا تعرضها أبدًا في الشيفرة على جانب العميل.

واجهة برمجة التطبيقات للوكلاء

قم بإدارة وكلائك الذكاء الاصطناعي. يمكنك إنشاء وكلاء جدد، وتعيين مطالبات النظام، وتكوين الإدخالات.

قائمة الوكلاء

GET /v1/agents

يعيد قائمة مجزأة من جميع الوكلاء المرتبطين بحسابك.

إنشاء وكيل

POST /v1/agents

قم بإنشاء وكيل ذكاء اصطناعي جديد. يتطلب name و systemPrompt في جسم JSON.

واجهة برمجة التطبيقات للمكالمات

ابدأ وأدر المكالمات الصادرة بشكل ديناميكي.

بدء مكالمة صادرة

POST /v1/calls/outbound

ابدأ مكالمة فورية إلى رقم محدد باستخدام معرف وكيل معين.

استرجاع تحليل المكالمة

GET /v1/calls/{call_id}/analytics

يعيد النص الكامل، والمدة، وتحليل المشاعر لمحادثة مكتملة.

الويب هوكس

استمع إلى الأحداث في الوقت الحقيقي. قم بتكوين نقاط نهاية الويب هوك في لوحة التحكم لتلقي حمولة HTTP POST عندما تنتهي مكالمة أو يتم الاستحواذ على جهة اتصال.