SparkTG

توثيق الحصول على فترات الاستراحة الفعّالة (v2)

الحصول على فترات الاستراحة الفعّالة (v2)

v2

الحصول على فترات الاستراحة الفعّالة (v2)

حالات الاستراحة المتاحة للوكلاء، ولوكيل واحد اختياريًا

API v2v2نقطة نهاية 1

نظرة عامة

اعرض حالات الاستراحة التي يمكن للوكلاء استخدامها في خدمتك، مثلًا لملء قائمة حالة الوكيل المنسدلة في نظام CRM أو CTI. تعني "الفعّالة" فترات الاستراحة التي يمكن للوكلاء استخدامها حاليًا: الاستراحات الافتراضية التي لم يوقفها المسؤول، إضافة إلى أي استراحات مخصصة فعّلها. الاستراحات الموقوفة للخدمة بأكملها لا تظهر في القائمة. القائمة دائمًا لخدمة الرمز المميز. أرسل agent-id لمعرفة الاستراحات التي أخفاها المسؤول لذلك الوكيل أيضًا. لا يتم احتسابها في الاستهلاك.

نقاط النهاية المتاحة

GET/api/v2/effective-breaks

المعاملات الرئيسية

agent-id(Integer)

معرّف الوكيل (قيمة id التي يعيدها GET /api/v2/agents). عند إرساله، تعود الاستراحات التي أخفاها المسؤول لهذا الوكيل مع "disabled": true. اتركه أو أرسله فارغًا للحصول على قائمة الخدمة دون علامات خاصة بالوكيل. يجب أن يكون الوكيل نشطًا وتابعًا لخدمة الرمز المميز.

سيناريوهات الاستخدام

استراحات الخدمة بأكملها

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

0 معاملمتاح في الأمثلة

استراحات وكيل واحد

أرسل agent-id. هنا أخفى المسؤول Leave للوكيل 319، لذا تعود مع "disabled": true. تبقى الاستراحة في القائمة لتتمكن من عرض اسمها ولونها؛ فقط لا تسمح للوكيل باختيارها.

0 معاملمتاح في الأمثلة

مثال سريع

جرّب هذه الواجهة بأمر cURL بسيط

استدعاء API أساسي
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 استبدل <YOUR_TOKEN> برمز API الخاص بك

معاينة الاستجابة

استجابة نموذجية من هذه الواجهة

استجابة نموذجية
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
عرض صيغة الاستجابة الكاملة في قسم الاستجابة