البدء باستخدام API وPlayground وwebhooks

اعثر على مفتاح API ونفّذ طلباً أول آمناً واربط إشعارات الأحداث دون كشف بيانات الدخول.

استخدم مرجع API الحالي

بعد تسجيل الدخول، افتح توثيق API. يتضمن المرجع نقاط الاتصال المدعومة والحقول المطلوبة والأمثلة. اعتمد عليه في تفاصيل الطلبات؛ فهذا الدليل يشرح سير العمل ولا يكرر مواصفات كل نقطة اتصال.

جهّز المفتاح

اتبع طلب التحقق من الهوية لعرض المفتاح أو نسخه. يتيح التوثيق نافذة تحقق مدتها خمس دقائق لعرض المفتاح واستخدام Playground؛ أما إنشاء المفتاح أو إعادة إنشائه فيتطلب تحققاً جديداً. عامله ككلمة مرور: احتفظ به على خادم تطبيقك، لا في المستودعات العامة أو شيفرة المتصفح أو لقطات الشاشة.

نفّذ طلباً أول آمناً

1. افتح Playground واختر نموذجاً للقراءة فقط يناسب حسابك، مثل عرض هويات SIP.
2. راجع الطريقة والمسار والمعاملات. استخدم المعرّفات المعادة لحسابك بدلاً من قيم الأمثلة.
3. اختر Run request ثم راجع حالة HTTP ومحتوى الاستجابة معاً.
4. استخدم مثال الطلب الموثق في تطبيقك مع تخزين آمن لبيانات الدخول.

يستخدم Playground حسابك. قد تنفذ طلبات إرسال الرسائل أو إجراء المكالمات أو طلب الخدمات عمليات حقيقية وتترتب عليها رسوم. لا تعتبره بيئة تجريبية مجانية.

أضف إشعارات webhook

في تكاملات الحساب، أضف عنوان HTTPS وحدد الأحداث المطلوبة. سر توقيع webhook منفصل عن مفتاح API. تحقق من التوقيعات وعالج كل حدث مرة واحدة وأكد الاستلام سريعاً. راجع سجلات التسليم عند استكشاف المشاكل. قبل تكرار عملية مدفوعة، راجع إرشادات API لإعادة المحاولة والطلبات المكررة؛ انتهاء المهلة وحده لا يثبت فشلها.

أدلة مرتبطة

• استكشاف مشاكل تسليم webhook
• شرح نشاطك في Communication reviews

اختر مرجع الخدمة الصحيح

يفصل المرجع بين Lookup وPricing وSIP وSMS وContacts وSpeech API وPhone Numbers وVoice API وCalls & recordings. راجع توثيق نقطة الاتصال لمعرفة الشروط والحقول والرسوم الدقيقة. للاتصال من المتصفح دليل Webphone SDK مستقل؛ وهو ليس التحكم بالمكالمات عبر Voice API من جهة الخادم.

إذن الوكيل بقراءة التوثيق لا يمنحه مفتاح صاحب الحساب أو تنفيذ Playground باستخدام المفتاح. اطلب من صاحب الحساب إدارة بيانات التكامل بدلاً من مشاركة تسجيل دخوله.

استخدم المراجع المعادة وتقسيم النتائج

تعامل مع مراجع المكالمات العامة كقيم لا تعدّلها: انسخ مرجع CALL- كاملاً من استجابتك بدلاً من تركيبه أو استخدام معرّف داخلي لنظام الهاتف. سجل المكالمات والمكالمات النشطة قائمتان مختلفتان. يتطلب التحكم أيضاً حالة مكالمة مدعومة؛ وجود سجل قديم لا يعني إمكانية التحكم به.

في سجل المكالمات، اتبع pagination.next_cursor ما دامت pagination.has_more صحيحة. أبقِ مرشحات days وlimit وهوية SIP الأصلية كما هي. لا تفك ترميز المؤشر ولا تعدّله. إذا انتهت صلاحيته، ابدأ قائمة جديدة وطابق النتائج حسب المرجع العام. الوقت الموثق في API على أنه UTC يحتاج إلى تحويل صريح للعرض، ولا يصبح تلقائياً وقت المتصفح المحلي.

عالج الأخطاء دون تكرار العمليات المدفوعة

اقرأ حالة HTTP والخطأ المنظم معاً. صحح أخطاء التحقق أو الصلاحيات قبل إعادة المحاولة، والتزم بمهلة الانتظار الموثقة عند بلوغ حد الطلبات. عند انتهاء مهلة عملية مدفوعة أو حدوث خطأ مؤقت، افحص حالتها وقواعد التكرار الخاصة بنقطة الاتصال قبل إرسالها مجدداً؛ فقد يؤدي تغيير المعرّفات إلى عملية جديدة. احتفظ للدعم بالمرجع العام والوقت والخطأ بعد تنقيحه من البيانات الحساسة، وليس بمفتاح API.