توثيق الانتقال إلى API v2
الانتقال إلى API v2
الانتقال إلى API v2
الانتقال إلى API v2
مصادقة قائمة على الرموز لتكاملك الحالي
يستدعي تكاملك واجهة SparkTG API على /api/v1 مع إرسال اسم مستخدم وكلمة مرور SparkTG في كل طلب. تنتقل مصادقة الـ API إلى رموز API موقّعة، متاحة لنقاط النهاية نفسها على /api/v2. تبقى نقاط النهاية والمعاملات والاستجابات كما هي: في معظم التكاملات يتغيّر فقط عنوان URL الأساسي وترويسة Authorization.
لماذا الانتقال إلى v2
إنشاء رمز API
- 1افتح Admin → Settings → API Access Tokens في لوحة تحكم SparkTG.
- 2ضمن Generate a new token، اختر أين تستلم كلمة المرور لمرة واحدة (SMS أو WhatsApp أو Email) واطلبها.
- 3أدخل رمز OTP، وأضف تسمية إن شئت (مثل اسم تكاملك) ثم أنشئ الرمز.
- 4انسخ الرمز واحفظه بأمان. يُعرض مرة واحدة فقط، ويبقى صالحًا لمدة عام.
يُنشئ مسؤول خدمتك الرمز. تعرض الشاشة نفسها رموزك وتتيح لك إلغاء أي منها. قبل انتهاء صلاحية الرمز، أنشئ رمزًا جديدًا وانقل تكاملك إليه.
ما الذي يتغيّر
الاستجابات الناجحة والأخطاء الخاصة بكل نقطة نهاية هي نفسها كما في v1. يُسجَّل كل طلب v2 لفوترة استخدام الـ API.
أمثلة
curl -u '<username>:<password>' \
'https://telephonycloud.co.in/api/v1/calls?service-id=<SERVICE_ID>&number=9XXXXXXXXX&agent-id=<AGENT_ID>'curl -H 'Authorization: Bearer <YOUR_TOKEN>' \
'https://telephonycloud.co.in/api/v2/calls?number=9XXXXXXXXX&agent-id=<AGENT_ID>'استبدل <YOUR_TOKEN> برمز API الخاص بك
أخطاء الرمز
يُفحص الرمز قبل تنفيذ نقطة النهاية، لذا قد يُرجع أي طلب v2 هذه الأخطاء.
{"status":"error","code":401,"message":"invalid or missing JWT"}{"status":"error","code":401,"message":"token revoked or unknown"}{"status":"error","code":403,"message":"service inactive (svcId=<id>)"}{"status":"error","code":403,"message":"svc-id does not match token's service"}نقاط نهاية v2
هذه الواجهات متاحة على v2 اليوم. وستنتقل بقية واجهات SparkTG إلى v2 قريبًا.
إجراء مكالمة (v2)
بدء مكالمة صادرة أو مجدولة
النقر للاتصال (v2)
طلبات معاودة اتصال موثّقة برمز OTP
إزالة المكالمات المجدولة (v2)
إلغاء المكالمات المجدولة
إنشاء مكالمات مجدولة دفعةً واحدة (v2)
جدولة ما يصل إلى 500 مكالمة في طلب واحد
إرسال رسالة WhatsApp (v2)
إرسال رسالة من خدمتك
جلب تفاصيل المكالمات بالجملة (v2)
سجلات المكالمات لفترة زمنية
تقرير تسجيل الدخول / الخروج (v2)
أوقات تسجيل دخول الوكلاء وخروجهم
عرض الوكلاء (v2)
جميع وكلاء خدمة الرمز
تحديث وكيل (v2)
تسجيل الدخول والخروج والاستراحات وتعديلات الملف الشخصي
الحصول على فترات الاستراحة الفعّالة (v2)
حالات الاستراحة المتاحة للوكلاء، ولوكيل واحد اختياريًا
تقرير سجلات المكالمات CDR (الإصدار 2)
سجلات تفاصيل المكالمات لفترة زمنية محددة
تقرير أداء الوكلاء (الإصدار 2)
أعداد المكالمات وأوقات التحدث والمعالجة والانتظار والرد لكل وكيل
التقرير الخام لتسجيل الدخول والخروج (الإصدار 2)
الجدول الزمني لتسجيل الدخول والاستراحة، بصف واحد لكل مقطع حالة
تقرير ملخص تسجيل الدخول والخروج (الإصدار 2)
مدد الخمول والتحدث والاستراحة والخروج لكل وكيل
عرض الخدمات (v2)
خدمة الرمز
قائمة أرقام DID لـ LeadSquared (v2)
أرقام DID لتكامل LeadSquared
