~.pbx.kazoo.name.~ Sambungan #

~.pbx.kazoo.name.~ koneksi menyediakan layanan pengumpulan data untuk ~.pbx.kazoo.name.~ Platform UCaaS/CPaaS.

Tabel di bawah ini menguraikan pengaturan yang diperlukan saat mengonfigurasi ~.pbx.kazoo.name.~ PBX sambungan:

Pengaturan	Deskripsi
Nama	Nama unik untuk dapat dengan mudah mengidentifikasi penggunaan koneksi.
API Kunci	API tombol untuk mengizinkan ~.Dimensions.~ untuk terhubung ke ~.pbx.kazoo.name.~ dan memantau komunikasi pelanggan.
ID Akun	~.pbx.kazoo.name.~ ID Akun penyewa untuk pelanggan.
Crossbar REST API	REST API koneksi URL.
Blackhole WebSocket API	Koneksi WebSocket URL
Negara	Lokasi koneksi sistem telepon. Ini digunakan untuk melokalkan nomor telepon untuk koneksi.

info

Pastikan jenis peristiwa diaktifkan pada Blackhole Soket Web.\

Versi yang Didukung #

~.pbx.kazoo.name.~ Rilis	~.Dimensions.~ Dukungan	Catatan
5.3	Didukung	Tidak ada
5.2	Didukung	Tidak ada
5.1	Didukung	Tidak ada
5.0	Didukung	Tidak ada
4.3¹	Didukung	ACDC didukung dari Sprint 85
4.2¹	Didukung	Tidak ada
< 4.x	Tidak Didukung	Tidak ada

Pengumpul data lebih lambat untuk memulai pada sistem 4.x karena harus meminta langganan peristiwa satu per satu. ↩︎

Persyaratan Konfigurasi #

Persyaratan berikut berlaku untuk ~.pbx.kazoo.name.~ PBX Koneksi:

Benda	Syarat
Rencana Penomoran	~.Dimensions.~ Membutuhkan paket penomoran unik untuk dapat membedakan antara perangkat dan pengguna. Perangkat 'SIP Nama pengguna tidak boleh sama dengan nomor ekstensi apa pun (termasuk Id ekstensi/kehadiran pengguna, alur panggilan, dll)
Pengguna	Semua ~.pbx.kazoo.name.~ pengguna HARUS memiliki hal-hal berikut agar dapat dipantau dengan benar: Alamat email yang valid dan unik yang dikonfigurasi terhadap akun mereka ID Keberadaan (digunakan untuk menampilkan nomor pengguna pada laporan) Selain itu, agar dapat masuk ke ~.Dimensions.~ portal, nama pengguna pengguna di ~.pbx.kazoo.name.~ harus berupa alamat email mereka.
Pemfilteran Ringkasan Agen	Status agen saat ini tidak dapat difilter oleh Antrean. Saat memfilter laporan Ringkasan Agen berdasarkan Antrean, semua agen akan ditampilkan dengan statusnya untuk rentang tanggal laporan yang sesuai. Hanya informasi panggilan yang dapat difilter terhadap tertentu jika diperlukan. Hal ini disebabkan oleh fakta bahwa informasi antrean tertentu tidak disimpan secara historis terhadap peristiwa status agen.

API Kunci #

Ini API dihasilkan dari ~.pbx.kazoo.name.~ menggunakan aplikasi "Otentikasi". Ini memungkinkan ~.Dimensions.~ untuk terhubung ke ~.pbx.kazoo.name.~ instalasi.

Tangkapan layar

ID Akun #

~.pbx.kazoo.name.~ ID Akun penyewa diperlukan untuk pelanggan tertentu di ~.pbx.kazoo.name.~ balei-balei. Ini memungkinkan ~.Dimensions.~ untuk mengidentifikasi pengguna dan panggilan pelanggan ini secara unik di ~.pbx.kazoo.name.~ balei-balei. Ini dapat ditemukan dari ~.pbx.kazoo.name.~ menggunakan aplikasi "Pusat Kontrol". Edit Nama Akun dan itu ditampilkan.

Tangkapan layar

Jika memungkinkan, API kunci pada tingkat tertinggi harus digunakan untuk mengizinkan ~.Dimensions.~ untuk memantau beberapa pelanggan melalui satu koneksi ke ~.pbx.kazoo.name.~. Ini akan mengurangi beban pada ~.pbx.kazoo.name.~ Sebagai contoh.

API Koneksi #

Untuk menyambungkan ke ~.pbx.kazoo.name.~ platform, ~.Dimensions.~ memerlukan akses ke REST dan API WebSocket. Silakan masukkan URL untuk ini di kotak yang disediakan.

Crossbar REST API URL #

Crossbar REST API digunakan untuk mengkueri informasi tentang pengguna, perangkat, dan callfows yang dikonfigurasi di akun pelanggan. Informasi ini digunakan untuk membuat akun pengguna dan membantu saat memodelkan lalu lintas panggilan.

'Jika Anda menggunakanui.zswitch.net, lalu Crossbar (REST) adalahhttps://ui.zswitch.net

note

Lepaskan "/v2" dari ujung URL jika ada.

Blackhole WebSocket URL #

Blackhole koneksi digunakan untuk memantau lalu lintas panggilan dan untuk melacak peristiwa perubahan dokumen untuk objek ~.Dimensions.~ model (pengguna, perangkat, alur panggilan, dll).

Saat mengonfigurasi detail koneksi, harap sertakan nomor port untuk Blackhole sambungan.

Jika Anda menggunakanapi.zswitch.net, lalu Blackhole (WebSocket) adalahwss://api.zswitch.net:5443

Jika menggunakan DNS SRV, nomor port tidak boleh diberikan.

note

Lepaskan "/v2" dari ujung URL jika ada.

ACDC Dukung

Jika menggunakan versi ~.pbx.kazoo.name.~ yang mendukung ACDC alih-alih Qubicle, Antrean & Peristiwa agen dapat dipantau jika soket EDR diaktifkan. Sama URL dikonfigurasi untuk Blackhole akan digunakan untuk terhubung ke soket EDR.

DNS SRV #

~.Dimensions.~ mendukung DNS Catatan SRV untuk Crossbar dan Blackhole Koneksi. saat menyiapkan rekaman SRV Anda, awalan yang tercantum di bawah ini harus digunakan untuk masing-masing jenis koneksi yang berbeda:

Jenis Koneksi	DNS Awalan SVR
Crossbar REST API	_crossbar._tcp
Blackhole Soket Web	_blackhole._tcp
WebRTC	_webrtc._tcp

Contoh Crossbar Konfigurasi SRV Contoh di bawah ini menunjukkan dua rekaman SRV untuk Crossbar sambungan. lebih banyak dapat dikonfigurasi sesuai kebutuhan.

Dalam ~.Dimensions.~ PBX Templat, Crossbar akan dikonfigurasi kehttps://zone1.example.com .

\_crossbar.\_tcp.zone01.example.com.	1 DI SRV 10 100 8443 apps001-ca.example.com.
\_crossbar.\_tcp.zone01.example.com.	1 DI SRV 100 10 8443 apps001-fl.example.com.

Contoh Blackhole Konfigurasi SRV

Dalam ~.Dimensions.~ PBX Templat, Blackhole akan dikonfigurasi kewss://zone1.example.com .

\_blackhole.\_tcp.zone01.example.com.	1 DI SRV 10 100 2096 apps001-ca.example.com.
\_blackhole.\_tcp.zone01.example.com.	1 DI SRV 100 10 2096 apps001-fl.example.com.

Contoh konfigurasi WebRTC SRV

\_webrtc.\_tcp.zone01.example.com.	1 DI SRV 10 100 5065 apps001-ca.example.com.
\_webrtc.\_tcp.zone01.example.com.	1 DI SRV 100 10 5065 apps001-fl.example.com.

note

Jika menggunakan salah satu ~.UcClient.~ softphone (Desktop, Seluler atau CRM), pengaturan Proksi Keluar tambahan perlu dikonfigurasi pada akun reseller Anda. Silahkan hubungi ~.Dimensions.~ dukungan untuk memiliki pengaturan ini.

~.pbx.kazoo.name.~ Persyaratan/Pembatasan Platform #

Sub Akun #

~.Dimensions.~ dapat dikonfigurasi untuk menyediakan dan memantau sub akun pelanggan secara otomatis, hingga 1 tingkat ke bawah. Untuk menggunakan fitur ini, koneksi pelanggan harus dikonfigurasi secara manual tanpa PBX templat.

Untuk informasi lebih lanjut, silakan merujuk ke sistem telepon bagian.

note

Pemantauan sub akun hanya tersedia di akun Pelanggan dan tidak dapat digunakan pada akun Reseller.

Pembatasan Tarif #

~.Dimensions.~ melakukan sejumlah kueri dan permintaan selama proses startup awal ketika mempelajari tentang ~.pbx.kazoo.name.~ Sebagai contoh. Jika batas tarif pada ~.pbx.kazoo.name.~ instance telah diatur terlalu rendah, ada kemungkinan startup awal ini gagal. Jika ini terjadi, seorang anggota ~.Dimensions.~ Dukungan akan menghubungi dengan informasi lebih lanjut.

Peristiwa WebSocket #

~.Dimensions.~ mengharuskan peristiwa berikut diaktifkan pada WebSocket untuk memungkinkan semua panggilan dimodelkan dan modifikasi pemrograman dilacak:

"data": {
	"panggilan": [	
		"panggilan. CHANNEL_CREATE. {CALL_ID}",
        "panggilan. CHANNEL_ANSWER. {CALL_ID}",
        "panggilan. CHANNEL_DESTROY. {CALL_ID}",
		"panggilan. CHANNEL_HOLD. {CALL_ID}",
		"panggilan. CHANNEL_UNHOLD. {CALL_ID}",
		"panggilan. CHANNEL_BRIDGE. {CALL_ID}",
		"panggilan. PARK_PARKED. {CALL_ID}",
		"panggilan. PARK_RETRIEVED. {CALL_ID}",
		"panggilan. PARK_ABANDONED. {CALL_ID}"
		][	
		"call.CHANNEL_CREATE.{CALL_ID}",
        "call.CHANNEL_ANSWER.{CALL_ID}",
        "call.CHANNEL_DESTROY.{CALL_ID}",
		"call.CHANNEL_HOLD.{CALL_ID}",
		"call.CHANNEL_UNHOLD.{CALL_ID}",
		"call.CHANNEL_BRIDGE.{CALL_ID}",
		"call.PARK_PARKED.{CALL_ID}",
		"call.PARK_RETRIEVED.{CALL_ID}",
		"call.PARK_ABANDONED.{CALL_ID}"
		],
	"konferensi": [ 
		"Konferensi.perintah. {CONFERENCE_ID}",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.undedeaf-member",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.anggota tuli",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.unmute-member",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.mute-member",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.mulai-bicara",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.berhenti berbicara",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.del-member",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.add-member",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.unlock",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.lock",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.conference-destroy",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.conference-create",
		"Konferensi.acara. {CONFERENCE_ID}. {CALL_ID}.\*"
		][ 
		"conference.command.{CONFERENCE_ID}",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.undeaf-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.deaf-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.unmute-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.mute-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.start-talking",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.stop-talking",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.del-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.add-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.unlock",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.lock",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.conference-destroy",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.conference-create",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.*"
		],
	"faks": [	
		"faks.status. {FAX_ID}",
		"faks.objek. {TINDAKAN}"
		][	
		"fax.status.{FAX_ID}",
		"fax.object.{ACTION}"
		],
	"objek": [
	"object.doc_created.account",
	"object.doc_created.callflow",
	"object.doc_created.device",
	"object.doc_created.faxbox",
	"object.doc_created.media",
	"object.doc_created.user",
	"object.doc_created.vmbox",
	"object.doc_created.fax",
	"object.doc_created.mailbox_message",
	"object.doc_created.call_recording",
	"object.doc_edited.account",
	"object.doc_edited.callflow",
	"object.doc_edited.device",
	"object.doc_edited.faxbox",
	"object.doc_edited.media",
	"object.doc_edited.user",
	"object.doc_edited.vmbox",
	"object.doc_edited.fax",
	"object.doc_edited.mailbox_message",
	"object.doc_edited.call_recording",
	"object.doc_deleted.account",
	"object.doc_deleted.callflow",
	"object.doc_deleted.device",
	"object.doc_deleted.faxbox",
	"object.doc_deleted.media",
	"object.doc_deleted.user",
	"object.doc_deleted.vmbox",
	"object.doc_deleted.fax",
	"object.doc_deleted.mailbox_message",
	"object.doc_dihapus.rekaman_panggilan"
	][
	"object.doc_created.account",
	"object.doc_created.callflow",
	"object.doc_created.device",
	"object.doc_created.faxbox",
	"object.doc_created.media",
	"object.doc_created.user",
	"object.doc_created.vmbox",
	"object.doc_created.fax",
	"object.doc_created.mailbox_message",
	"object.doc_created.call_recording",
	"object.doc_edited.account",
	"object.doc_edited.callflow",
	"object.doc_edited.device",
	"object.doc_edited.faxbox",
	"object.doc_edited.media",
	"object.doc_edited.user",
	"object.doc_edited.vmbox",
	"object.doc_edited.fax",
	"object.doc_edited.mailbox_message",
	"object.doc_edited.call_recording",
	"object.doc_deleted.account",
	"object.doc_deleted.callflow",
	"object.doc_deleted.device",
	"object.doc_deleted.faxbox",
	"object.doc_deleted.media",
	"object.doc_deleted.user",
	"object.doc_deleted.vmbox",
	"object.doc_deleted.fax",
	"object.doc_deleted.mailbox_message",
	"object.doc_deleted.call_recording"
	]
}

Crossbar API Permintaan #

Berikut Crossbar API permintaan digunakan oleh Dimensi:

Penggunaan Umum

{CROSSBAR}/v2/api_auth,httpMethod=PUT
{CROSSBAR}/v2/websockets,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/api_key,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/descendants?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID}/quickcall/{DESTINATION},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID}/presence,httpMethod=POST
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices/{DEVICEID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices/{DEVICEID}/quickcall/{DESTINATION},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows? {Filter String Kueri},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows/{CALLFLOWID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/groups?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/groups/{GROUPID}?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/conferences?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/conferences/{CONFERENCEID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/vmboxes?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/metaflows,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/storage,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels/{CHANNELID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels/{CHANNELID},httpMethod=PUT
{CROSSBAR}/v2/accounts/{ACCOUNTID}/resources,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_queues?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_queues/{QUEUEID},httpMethod=GET

~.UcClient.~ Kontrol ACD

Digunakan saat mengontrol status agen dari ~.UcClient.~ dan Dasbor.

{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/status,httpMethod=POST,content={"data":{"recipient_ids":[" {RECIPIENTID1}","{RECIPIENTID2}"]["{RECIPIENTID1}","{RECIPIENTID2}"]}}
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/{USERID},httpMethod=POST
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/{USERID}/status,httpMethod=POST

Kontrol Profil Kehadiran

Digunakan saat Profil Kehadiran diaktifkan pada ~.UcClient.~.

{CROSSBAR}/v2/accounts/{accountId}/users/{userId},httpMethod=PATCH
{CROSSBAR}/v2/accounts/{accountId}/callflows/{callFlowId},httpMethod=POST
{CROSSBAR}/v2/accounts/{accountId}/callflows/groups/{groupId},httpMethod=POST
{CROSSBAR}/v2/accounts/{accountId}/callflows/groups/{groupId},httpMethod=POST

ACDC Dukungan pada Open Source

Digunakan jika menjalankan Open source ~.pbx.kazoo.name.~ menggunakan ACDC dan peristiwa agen/antrean EDR.

{crossbar}/v2/accounts/{accountId}/queues,httpMethod=GET
{crossbar}/v2/accounts/{accountId}/queues/{queueId},httpMethod=GET
{crossbar}/v2/accounts/{accountId}/queues/{queueId}/stats_summary,httpMethod=GET
{crossbar}/v2/accounts/{accountId}/agents/{recipientId}/status,httpMethod=GET
{crossbar}/v2/accounts/{accountId}/agents/{userId}/status,httpMethod=POST

Pembatasan Platform #

Pembatasan yang tercantum di bawah ini berlaku untuk ~.pbx.kazoo.name.~ Didukung.

Pembatasan	Deskripsi
Pelacakan alur panggilan	Tidak ada informasi panggilan yang dapat dikumpulkan melalui soket web API untuk panggilan saat mereka berada dalam alur panggilan. Pelacakan panggilan akan dimulai setelah panggilan berinteraksi dengan pengguna/perangkat atau Antrean Pusat Panggilan. Saat dalam alur panggilan, panggilan akan diperlakukan sebagai dalam status 'Antrean'.
Pelacakan Pesan Suara	Panggilan yang dialihkan ke pesan suara dari telepon tidak dapat dilacak sebagai pesan suara dan sebaliknya akan dimodelkan sebagai tidak dijawab. Hal ini disebabkan oleh informasi yang tidak memadai yang diberikan melalui soket web API agar skenario yang benar dapat dimodelkan.
Pelacakan Transfer yang Diumumkan	Karena cara peristiwa panggilan dihasilkan, kami menyarankan agar ponsel apa pun dikonfigurasi untuk transfer buta. Jika telepon tidak dikonfigurasi untuk transfer buta dan transfer yang dihadiri ditutup sebelum terhubung, panggilan mungkin tidak dimodelkan dengan benar. Hal ini disebabkan oleh keterbatasan di FreeSWITCH.
Panggilan cepat	Jika menjalankan ~.pbx.kazoo.name.~ versi sebelum 5.0, Panggilan Cepat yang dijawab pada perangkat eksternal (sel/rumah) menghasilkan entri log panggilan yang tidak valid.