SparkTG

توثيق وثائق API

وثائق API

v1.0ينتقل إلى v2

تنتقل واجهات SparkTG إلى v2

تصف هذه الصفحات API v1. تنتقل جميع واجهات SparkTG إلى API v2 برموز API موقّعة بدلًا من اسم المستخدم وكلمة المرور: استخدم v2 حيثما كان متاحًا.

الانتقال إلى API v2

وثائق API

المرجع الخاص بواجهات API للهاتف السحابي من SparkTG

نظرة عامةv1.0

واجهة SparkTG Cloud Telephony API

مقدمة

SparkTG مزود خدمات هاتف سحابي. الهاتف السحابي خدمة عند الطلب توفر ميزات هاتفية قوية وموثوقة للمؤسسات التي تقدم المنتجات والخدمات.

الوصول عبر الشبكة: الإمكانات متاحة عبر الشبكة ويُوصل إليها بآليات قياسية. يمكن للمستخدمين تسجيل الدخول من أي مكان والتحكم في خدماتهم.

تجميع الموارد: تُجمَّع موارد الاتصالات لخدمة عدة عملاء عبر نموذج تعدد المستأجرين، مع تخصيص الموارد المادية والافتراضية وإعادة تخصيصها ديناميكيًا بحسب الطلب. وهذا يقلل تكلفة تطوير خدمة هاتفية خاصة ويتيح الدفع فقط مقابل الموارد المستخدمة.

المرونة: يمكن تهيئة منافذ الهاتف بسرعة ومرونة، وفي بعض الحالات تلقائيًا، للتوسع السريع صعودًا وتحريرها بسرعة للتقليص نزولًا.

الخدمة المقيسة: يتحكم النظام السحابي تلقائيًا في استخدام الموارد ويحسّنه عبر قدرة على القياس بمستوى تجريد مناسب لنوع الخدمة (مثل عدد المكالمات الواردة والصادرة والمكالمات المزعجة). ويمكن مراقبة استخدام الموارد والتحكم فيه والإبلاغ عنه، مما يوفر الشفافية لكل من مزود الخدمة ومستهلكها. وانطلاقًا من هذه الأهداف، تطرح SparkTG واجهات API لمعظم خدماتها ليتمكن العملاء من تجربتها ودمجها بسهولة في تطبيقاتهم (الويب أو سطح المكتب أو الجوال).

الافتراضات

هذا المستند موجه إلى المطورين ويتطلب معرفة أساسية بمنصة الهاتف السحابي من SparkTG. يجب على SparkTG تهيئة خدمة API مسبقًا لكل عميل قبل أن يتمكن من استخدامها في تطبيقاته.

إرسال ترويسات المصادقة الأساسية: لدينا واجهات API قائمة على REST تستخدم المصادقة الأساسية (Basic). يجب عليك إرسال ترويسات المصادقة الأساسية بنفسك، وذلك بتمرير سلسلة نصية بالصيغة username:password.

الاتصالات السحابية

خدمة اتصالات عند الطلب توفر مزايا قوية وموثوقة للمؤسسات. يمكن الوصول إلى الإمكانات عبر الشبكة من أي مكان.

تجميع الموارد

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

المرونة

توفير منافذ الاتصالات تلقائيًا وبسرعة للتوسع، وتحريرها سريعًا للتقليص حسب الحاجة.

خدمة مقيسة

تحكم تلقائي في الموارد مع إمكانات القياس. راقب الاستخدام بشفافية لكل من المزود والمستهلك.

المصادقة الأساسية (Basic)

نستخدم واجهات API قائمة على REST مع المصادقة الأساسية. يجب عليك إرسال ترويسات المصادقة الأساسية بنفسك، وذلك بتمرير سلسلة نصية بالصيغة username:password.

صيغة المصادقة:

username:password

مررها في ترويسة Authorization أو استخدم الخيار curl -u

متطلبات المطورين

• يلزم الإلمام الأساسي بمنصة SparkTG Cloud Telephony

• يجب على SparkTG تهيئة خدمة API مسبقًا لكل عميل

• واجهات REST مع دعم المصادقة الأساسية

• متوافقة مع تطبيقات الويب وسطح المكتب والجوال

البدء

1. اطلب الوصول إلى API

تواصل مع SparkTG لتهيئة خدمة API لحساب عميلك.

2. احصل على بيانات الاعتماد

استلم بيانات اعتمادك (اسم المستخدم:كلمة المرور) للمصادقة الأساسية.

3. اختر واجهات API

اختر من بين إدارة المكالمات وواجهات الوكلاء والمراسلة وغيرها.

4. نفّذ التكامل

استخدم نقاط نهاية REST في تطبيقات الويب أو سطح المكتب أو الجوال.

فئات API المتاحة

إدارة الوكلاء

تسجيل الدخول والحالة والاستراحات وإعدادات الوكلاء

إدارة المكالمات

إجراء المكالمات وتحويلها وجدولتها والتحكم بها

المراسلة وOTP

خدمات الرسائل النصية SMS والتحقق عبر OTP

التحليلات

سجل المكالمات والتقارير وبيانات لوحة المعلومات

الأحداث الفورية

أحداث WebSocket وتكامل Webhook

الإعدادات

إعدادات التحويل وتهيئة الخدمة