PHP 7.1 atau lebih tinggi dan ekstensi json
.
composer require innoscripta/ sipgate
Inisialisasi kelas sipgate
:
$ sipgate = Orkhanahmadov sipgate sipgate ();
Otentikasi dasar
Anda dapat memberikan nama pengguna dan kata sandi otentikasi dasar saat menginisialisasi kelas:
$ sipgate = Orkhanahmadov sipgate sipgate ( ' [email protected] ' , ' secret ' );
Atau Anda dapat mengatur otentikasi dasar dengan metode setBasicAuthCredentials()
:
$ sipgate = Orkhanahmadov sipgate sipgate ();
$ sipgate -> setBasicAuthCredentials ( ' [email protected] ' , ' secret ' );
Informasi akun:
$ sipgate -> account ();
Mengembalikan serangkaian detail akun.
Dapatkan pengguna:
$ sipgate -> users ();
Mengembalikan array pengguna yang terdaftar di bawah akun. Setiap item dalam array adalah turunan dari Orkhanahmadov sipgate ResourcesUser
dan memiliki properti berikut:
$ 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
Dapatkan perangkat pengguna:
Untuk mendapatkan perangkat pengguna, gunakan metode devices()
dan berikan instance pengguna atau ID pengguna.
$ sipgate -> devices ( $ user );
// or
$ sipgate -> devices ( ' ABC-123 ' );
Mengembalikan rangkaian perangkat yang terdaftar untuk pengguna tertentu. Setiap item dalam array adalah turunan dari Orkhanahmadov sipgate ResourcesDevice
dan memiliki properti berikut:
$ 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
Panggilan aktif:
Gunakan metode calls()
untuk mendapatkan daftar panggilan yang sedang dilakukan.
$ sipgate -> calls ();
Mengembalikan rangkaian panggilan yang sedang dilakukan. Setiap item dalam array adalah turunan dari Orkhanahmadov sipgate ResourcesCall
dan memiliki properti berikut:
$ 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
Memulai panggilan baru:
Gunakan metode call()
untuk memulai panggilan baru. Metode menerima 3 parameter:
$device
- Menerima contoh perangkat atau ID perangkat. Ini menentukan perangkat mana yang ingin Anda gunakan untuk melakukan panggilan.$callee
- Nomor telepon yang ingin Anda hubungi.$callerId
(opsional) - Atur parameter ini jika Anda ingin menampilkan nomor berbeda ke nomor yang dihubungi lainnya. Jika dilewati, nomor $device
akan digunakan. $ sipgate -> call ( $ device , $ callee , $ callerId );
Mengembalikan ID sesi panggilan.
Panggilan telepon yang sedang berlangsung:
Gunakan metode hangup()
untuk menutup panggilan yang sedang berlangsung. Metode menerima ID panggilan sebagai parameter:
$ sipgate -> hangup ( ' ABC-123 ' );
Rekam panggilan yang sedang berlangsung:
Gunakan metode record()
untuk merekam panggilan yang sedang berlangsung. Metode menerima 3 parameter:
$callId
- ID panggilan unik.$value
- true
atau false
, menentukan mulai atau berhentinya perekaman.$announcement
- true
atau false
, menentukan apakah Anda ingin memutar pengumuman tentang panggilan yang direkam. $ sipgate -> record ( $ callId , $ value , $ announcement );
Riwayat panggilan:
Gunakan metode history()
untuk mendapatkan riwayat panggilan. Metode menerima berbagai opsi:
connectionIds
- array
, mendefinisikan daftar ekstensitypes
- array
, mendefinisikan daftar tipe yang ingin Anda terima dalam riwayat, mungkin berisi salah satu dari banyak nilai berikut: "CALL", "VOICEMAIL", "SMS", "FAX"directions
- array
, menentukan daftar arah panggilan yang ingin Anda terima dalam riwayat, mungkin berisi salah satu dari banyak nilai berikut: "INCOMING", "OUTGOING", "MISSED_INCOMING", "MISSED_OUTGOING"archived
- bool
, setel true
jika Anda hanya ingin menerima item riwayat yang diarsipkanstarred
- Menentukan apakah Anda ingin menerima item riwayat yang berbintang dari yang tidak berbintang, salah satunya: "STARRED", "UNSTARRED"from
- Mendefinisikan tanggal mulai sejarah. Harus dalam format ISO8601to
- Mendefinisikan tanggal akhir sejarah. Harus dalam format ISO8601phonenumber
- Mendefinisikan nomor telepon untuk mencari dalam sejarahlimit
- Mendefinisikan nilai "per halaman" untuk item riwayatoffset
- Mendefinisikan nilai "offset" untuk item riwayat $ sipgate -> history ([ ' from ' => ' 2019-07-10T19:32:18Z ' , ' to ' => ' 2019-07-22T19:32:18Z ' ]);
Mengembalikan array item riwayat. Setiap item dalam array adalah turunan dari Orkhanahmadov sipgate ResourcesHistory
dan memiliki properti berikut:
$ 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
Silakan lihat CHANGELOG untuk informasi lebih lanjut tentang apa yang berubah baru-baru ini.
Silakan lihat KONTRIBUSI untuk rinciannya.
Jika Anda menemukan masalah terkait keamanan, silakan kirim email ke [email protected] daripada menggunakan pelacak masalah.
Lisensi MIT (MIT). Silakan lihat File Lisensi untuk informasi lebih lanjut.