PHP 7.1 أو أعلى وامتداد json
.
composer require innoscripta/ sipgate
تهيئة فئة sipgate
:
$ sipgate = Orkhanahmadov sipgate sipgate ();
المصادقة الأساسية
يمكنك تمرير اسم مستخدم وكلمة مرور المصادقة الأساسية عند تهيئة الفصل:
$ sipgate = Orkhanahmadov sipgate sipgate ( ' [email protected] ' , ' secret ' );
أو يمكنك تعيين المصادقة الأساسية باستخدام طريقة setBasicAuthCredentials()
:
$ sipgate = Orkhanahmadov sipgate sipgate ();
$ sipgate -> setBasicAuthCredentials ( ' [email protected] ' , ' secret ' );
معلومات الحساب:
$ sipgate -> account ();
إرجاع مجموعة من تفاصيل الحساب.
الحصول على المستخدمين:
$ sipgate -> users ();
إرجاع مجموعة من المستخدمين المسجلين ضمن الحساب. كل عنصر في المصفوفة هو مثيل لـ Orkhanahmadov sipgate ResourcesUser
وله الخصائص التالية:
$ user -> id ; // string
$ user -> firstname ; // string
$ user -> lastname ; // string
$ user -> email ; // string
$ user -> defaultDevice ; // string
$ user -> busyOnBusy ; // bool
$ user -> addressId ; // string
$ user -> directDialIds ; // array
$ user -> admin ; // bool
الحصول على أجهزة المستخدم:
للحصول على أجهزة المستخدم، استخدم طريقة devices()
وتمرير مثيل مستخدم أو معرف مستخدم.
$ sipgate -> devices ( $ user );
// or
$ sipgate -> devices ( ' ABC-123 ' );
إرجاع مجموعة من الأجهزة المسجلة لمستخدم معين. كل عنصر في المصفوفة هو مثيل لـ Orkhanahmadov sipgate ResourcesDevice
وله الخصائص التالية:
$ device -> id ; // string
$ device -> alias ; // string
$ device -> type ; // string
$ device -> online ; // bool
$ device -> dnd ; // bool
$ device -> activePhonelines ; // array
$ device -> activeGroups ; // array
$ device -> credentials ; // array
$ device -> registered ; // array
$ device -> emergencyAddressId ; // string
$ device -> addressUrl ; // string
المكالمات النشطة:
استخدم طريقة calls()
للحصول على قائمة بالمكالمات الجارية حاليًا.
$ sipgate -> calls ();
إرجاع مجموعة من المكالمات المنشأة حاليًا. كل عنصر في المصفوفة هو مثيل لـ Orkhanahmadov sipgate ResourcesCall
وله الخصائص التالية:
$ call -> id ; // string
$ call -> firstname ; // string
$ call -> lastname ; // string
$ call -> email ; // string
$ call -> defaultDevice ; // string
$ call -> busyOnBusy ; // bool
$ call -> addressId ; // string
$ call -> directDialIds ; // array
$ call -> admin ; // bool
بدء مكالمة جديدة:
استخدم طريقة call()
لبدء مكالمة جديدة. تقبل الطريقة 3 معلمات:
$device
- يقبل مثيل الجهاز أو معرف الجهاز. يحدد هذا الجهاز الذي تريد استخدامه لإجراء مكالمة.$callee
- رقم الهاتف الذي تريد الاتصال به.$callerId
(اختياري) - قم بتعيين هذه المعلمة إذا كنت تريد إظهار رقم مختلف للمتصل به الآخر. عند تخطي رقم $device
سيتم استخدامه. $ sipgate -> call ( $ device , $ callee , $ callerId );
إرجاع معرف جلسة المكالمة.
إنهاء المكالمة الجارية:
استخدم طريقة hangup()
لتعليق المكالمة الجارية. يقبل الأسلوب معرف الاتصال كمعلمة:
$ sipgate -> hangup ( ' ABC-123 ' );
تسجيل المكالمات الجارية:
استخدم طريقة record()
لتسجيل المكالمات الجارية. تقبل الطريقة 3 معلمات:
$callId
- معرف المكالمة الفريد.$value
- true
أم false
، يحدد بداية التسجيل أو إيقافه.$announcement
- true
أم false
، يحدد ما إذا كنت تريد تشغيل إعلان حول تسجيل المكالمة. $ sipgate -> record ( $ callId , $ value , $ announcement );
سجل المكالمات:
استخدم طريقة history()
للحصول على سجل المكالمات. تقبل الطريقة مجموعة من الخيارات:
connectionIds
- array
، تحدد قائمة الامتداداتtypes
- array
، تحدد قائمة الأنواع التي ترغب في استقبالها في السجل، وقد تحتوي على واحدة من القيم التالية: "CALL"، "VOICEMAIL"، "SMS"، "FAX"directions
- array
، تحدد قائمة اتجاهات المكالمات التي تريد تلقيها في السجل، وقد تحتوي على واحدة من القيم التالية: "INCOMING"، "OUTGOING"، "MISSED_INCOMING"، "MISSED_OUTGOING"archived
- bool
، اضبطه true
إذا كنت تريد تلقي عناصر السجل المؤرشفة فقطstarred
- يحدد ما إذا كنت تريد الحصول على عناصر السجل المميزة بنجمة أو غير المميزة بنجمة، أحد هذه العناصر: "مميزة بنجمة"، "غير مميزة بنجمة"from
- يحدد تاريخ بدء التاريخ. يجب أن يكون بتنسيق ISO8601to
- يحدد تاريخ انتهاء التاريخ. يجب أن يكون بتنسيق ISO8601phonenumber
- يحدد رقم الهاتف للبحث في التاريخlimit
- يحدد قيمة "لكل صفحة" لعناصر السجلoffset
- يحدد قيمة "الإزاحة" لعناصر السجل $ sipgate -> history ([ ' from ' => ' 2019-07-10T19:32:18Z ' , ' to ' => ' 2019-07-22T19:32:18Z ' ]);
إرجاع مجموعة من عناصر التاريخ. كل عنصر في المصفوفة هو مثيل لـ Orkhanahmadov sipgate ResourcesHistory
وله الخصائص التالية:
$ history -> id ; // string
$ history -> source ; // string
$ history -> target ; // string
$ history -> sourceAlias ; // string
$ history -> targetAlias ; // string
$ history -> type ; // string
$ history -> created ; // string
$ history -> lastModified ; // string
$ history -> direction ; // string
$ history -> incoming ; // bool
$ history -> status ; // string
$ history -> connectionIds ; // array
$ history -> read ; // bool
$ history -> archived ; // bool
$ history -> note ; // string
$ history -> endpoints ; // array
$ history -> starred ; // bool
$ history -> labels ; // array
$ history -> callId ; // string
$ history -> recordingUrl ; // string
$ history -> recordings ; // array
$ history -> duration ; // int
$ history -> responder ; // string
$ history -> responderAlias ; // string
composer test
الرجاء مراجعة سجل التغيير لمزيد من المعلومات عما تغير مؤخرًا.
يرجى الاطلاع على المساهمة للحصول على التفاصيل.
إذا اكتشفت أي مشكلات متعلقة بالأمان، فيرجى إرسال بريد إلكتروني إلى [email protected] بدلاً من استخدام أداة تعقب المشكلات.
رخصة معهد ماساتشوستس للتكنولوجيا (MIT). يرجى الاطلاع على ملف الترخيص لمزيد من المعلومات.