Webhook #
Webhook pasca panggilan memberikan informasi tentang setiap panggilan yang diselesaikan di sistem. Informasi ini dapat digunakan untuk memperbarui sistem eksternal atau memulai otomatisasi alur kerja, menggunakan produk seperti Azure Logic Apps atau Zapier.
Contoh kasus penggunaan:
- Menambahkan peristiwa riwayat panggilan terhadap a CRM rekor
- Tambahkan detail pemutaran rekaman panggilan ke a CRM rekor
- Rekor penjualan yang sukses di CRM
- Lacak keluhan pelanggan di sistem eksternal
info
Beberapa Webhook dapat dikonfigurasi (tergantung lisensi) untuk memberikan informasi pasca panggilan ke sistem eksternal yang berbeda sesuai kebutuhan.
Mengonfigurasi Webhook #
Kondisi Filter #
Secara default, webhook akan diaktifkan untuk semua sesi panggilan kecuali filter diterapkan. Filter dapat ditambahkan untuk sebagian besar properti panggilan untuk memungkinkan webhook dibatasi agar hanya diaktifkan pada panggilan 'Eksternal' misalnya, atau panggilan yang cocok dengan nomor 'DID' tertentu.
Tambahkan opsi filter sesuai kebutuhan. Ketika beberapa bidang filter ditambahkan, mereka digabungkan menggunakan ' DAN' Operator.
info
Untuk informasi lebih lanjut tentang pemfilteran, lihat di sini
Perbuatan #
Parameter | Pilihan | Deskripsi |
---|---|---|
URL | https:// | Berikan HTTPS URL bahwa pemicu akan memanggil saat ditembakkan. |
Metode permintaan | GET, POST, PUT | Pilih metode permintaan yang diperlukan untuk webhook. |
Format permintaan | JSON, Data Formulir | Pilih format permintaan yang diperlukan untuk webhook jika POST atau PUT dipilih sebagai metode Permintaan. |
Data muatan tambahan | Pasangan kunci/nilai | Jika diperlukan, informasi statis tambahan dapat ditambahkan ke payload webhook. Masukkan data tambahan sebagai pasangan kunci/nilai sesuai kebutuhan. |
Coba lagi | 0 - 10 | Standar 1. Masukkan berapa kali webhook harus mencoba lagi jika suatu saat ada yang gagal |
warning
Konfigurasi pemicu webhook di-cache untuk meningkatkan kinerja. Setiap pemicu baru atau perubahan pada pemicu yang ada mungkin memerlukan waktu hingga 10 menit sebelum diterapkan.
info
Batas waktu untuk permintaan webhook adalah 10 detik. Waktu antara upaya coba lagi sama dengan Jumlah Percobaan x 2 Detik
Data Muatan
Tabel di bawah ini menunjukkan data yang disediakan dalam payload pemicu.
Parameter | Deskripsi |
---|---|
ID pemicu | Id unik untuk pemicu permintaan hook web sedang diaktifkan. |
Id | Id entitas yang berubah (Id pengguna atau Id penyewa). |
tenantId | Id penyewa pelanggan yang terkait dengan peristiwa. |
Cdr | Payload data panggilan |
data kustom | Jika dikonfigurasi terhadap pemicu, informasi pasangan kunci/nilai muatan tambahan akan diteruskan di sini. |
CDR Data
Parameter | Deskripsi |
---|---|
Id | Id sesi untuk CDR rekor. |
Tipe d | CDR jenis catatan - "CloudSessionCdr" |
sVer | CDR Versi - 1 |
PBXId | ~.Dimensions.~ id untuk platform komunikasi CDR berasal dari (misalnya ~.pbx.kazoo.name.~) |
Nama pbx | Nama platform komunikasi yang dikonfigurasi |
tz | Pengidentifikasi TZ untuk waktu panggilan. |
mulai | Waktu mulai sesi panggilan. |
menjawab | Waktu panggilan pertama kali dijawab. |
ujung | Waktu akhir sesi panggilan. |
Dur | Durasi panggilan dalam detik. |
cincin | Waktu dering panggilan dalam detik. |
bicara | Waktu bicara panggilan dalam hitungan detik. |
pegang | Tahan waktu panggilan dalam hitungan detik. |
taman | Waktu parkir panggilan dalam hitungan detik. |
hilang | Indikasi apakah panggilan ditinggalkan - 1/0 |
Taman lostin | Indikasi apakah panggilan ditinggalkan saat diparkir - 1/0 |
aban | Indikasi apakah panggilan itu adalah panggilan dering pendek atau tidak - 1/0 |
Ans | Indikasi apakah panggilan itu ans - 1/0 |
pendek | Indikasi apakah panggilan dipanggil memiliki durasi pendek - 1/0 |
sebab | Jelaskan penyebab panggilan. |
Dir | Arah panggilan. 0 - Tidak diketahui, 1 - Internal, 2 - Masuk, 3 - Keluar, 4 - Keduanya |
jenis | Jenis panggilan. 0 - Tidak diketahui, 1 - Internal, 2 - Eksternal |
t2t | Indikasi apakah panggilan itu adalah panggilan trunk to trunk - 1/0 |
cliNum | Nomor Id Penelepon (CLI) di E.164 format. |
cliName | Nama penelepon |
cliLoc | Lokasi CLI |
cliArea | Kode area CLI |
cliState | Status CLI (Khusus AS) |
cliCtry | Negara CLI |
ddiNum | Nomor DID di E.164 format. |
Nama ddi | Nama DID |
fRngDevNum | Pertama berdering nomor perangkat. |
fRngDevName | Pertama berdering nama perangkat. |
lRngDevNum | Nomor perangkat terakhir berdering. |
lRngDevNama | Nama perangkat terakhir berdering. |
ansDevNum | Menjawab nomor perangkat. |
ANSdevName | Menjawab nama perangkat. |
lAnsDevNum | Nomor perangkat penjawab terakhir. |
lAnsDevNama | Nama perangkat penjawab terakhir. |
fRngUsrNum | Pertama berdering nomor pengguna. |
fRngUsrName | Nama pengguna pertama berdering. |
lRngUsrNum | Nomor pengguna terakhir berdering. |
lRngUsrName | Nama pengguna terakhir berdering. |
ansUsrNum | Menjawab nomor pengguna. |
AnsUsrName | Menjawab nama pengguna. |
lAnsUsrNum | Nomor pengguna yang terakhir menjawab. |
lAnsUsrName | Nama pengguna yang terakhir menjawab. |
fRngAgtNum | Pertama berdering nomor agen. |
fRngAgtNama | Nama agen pertama berdering. |
lRngAgtNum | Nomor agen terakhir berdering. |
lRngAgtNama | Nama agen terakhir berdering. |
ansAgtNum | Nomor agen penjawab. |
ansAgtName | Menjawab nama agen. |
lAnsAgtNum | Nomor agen penjawab terakhir. |
lAnsAgtName | Nama agen penjawab terakhir. |
ID rteID | Nomor awalan. Nomor apa pun yang ditambahkan ke CLI sebagai awalan selama perutean melalui platform komunikasi. |
Nama rteName | Nama awalan. String apa pun yang ditambahkan ke Nama Penelepon sebagai awalan selama perutean melalui platform komunikasi. |
fRngGroupName | Nama grup pertama berdering. |
lRngNama Grup | Nama grup terakhir berdering. |
NamaGrup | Menjawab nama grup. |
memiliki Rec | Indikasi apakah panggilan direkam - 1/0 |
menilai | Indikasi apakah panggilan telah dinilai - 1/0 |
tarif Biaya | Biaya tarif (ganda). |
rateBand | Nama band untuk tarif. |
Nama tarif | Nama tarif yang diterapkan. |
recordingId | String array Id untuk rekaman apa pun yang terkait dengan sesi panggilan ini. |
direktoricocok | Item direktori kontak Array kontak apa pun yang cocok dengan panggilan. |
Tags | Array yang berisi pasangan kunci/nilai dari tag apa pun yang diterapkan pada panggilan. |
CDR Item Direktori Kontak
Kunci | Deskripsi | Jenis |
---|---|---|
titel | Judul kontak (Bapak, Nyonya, Dr dll.) | tali |
Nama penuh | Nama lengkap untuk kontak. Ini digunakan dalam laporan dan ~.UcClient.~ untuk membantu pengguna mengidentifikasi penelepon. | tali |
Nama perusahaan | Nama perusahaan tempat kontak bekerja. | tali |
Judul pekerjaan | Posisi kontak dengan perusahaan. | tali |
Telepon1 ke Telepon4 | Alamat email kontak untuk kontak. | E.164 |
Hingga 4 bidang nomor telepon kontak yang berbeda | tali | |
Kad crm | Id unik untuk rekaman kontak dari eksternal CRM sistem | tali |
field1 ke field 10 | 10 bidang untuk membawa data kustom apa pun untuk catatan kontak | tali |
tip
Itu triggerId dapat ditemukan dengan mengedit pemicu yang dikonfigurasi di Portal Pelanggan dan menyalin GUID dari akhir URL. misalnya https://myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000
Contoh JSON Payload
Contoh JSON format muatan untuk PUT/POST Permintaan:
{
"triggerId": "00000000-0000-0000-0000-0000000000000",
"id": "00000000-0000-0000-0000-00000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000000",
"cdr": {
"id": "00000000-0000-0000-0000-00000000000000",
"dType": "CloudSessionCdr",
"sVer": 1,
"pbxId": "00000000-0000-0000-0000-00000000000000",
"pbxName": "BenDV1 - Pengembang - Ben",
"tz": "Eropa/London",
"mulai": "2024-05-29T09:37:35+01:00",
"akhir": "2024-05-29T09:37:45+01:00",
"dur": 10,
"cincin": 10,
"hilang": 1,
"cause": "NORMAL_ KLIRING",
"dir": 2,
"jenis": 2,
"cliNum": "\\u002B4470000000000",
"cliLoc": "Inggris Raya",
"cliCtry": "GB",
"ddiNum": "\\u002B441610000000",
"fRngDevNum": "pengguna_ **\*\***",
"fRngDevName": "(T42S) Pengguna Uji",
"lRngDevNum": "user\_**\*\***",
"lRgDevName": "(T42S) Pengguna Uji",
"fRngUsrNum": "302",
"fRngUsrName": "Pengguna Uji",
"lRngUsrNum": "302",
"lRngUsrName": "Pengguna Uji",
"fRngAgtNum": "302",
"fRngAgtName": "Pengguna Uji",
"lRngAgtNum": "302",
"lRngAgtName": "Pengguna Uji",
"hasRec": 1,
"recordingIds": [" 00000000-0000-0000-0000-0000000000000"]["00000000-0000-0000-0000-000000000000"],
"directoryMatches": [ {
"dirName": "Global Saya",
"dirId": "00000000-0000-0000-0000-00000000000000",
"dirType": "DirektoriContactMatch",
"contactId": "00000000-0000-0000-0000-00000000000000",
"bidang": {
"fullName": "Contoh Kontak",
"companyName": "Perusahaan",
"jobTitle": "Jabatan",
"email": "Alamat Email",
"field1": "field1",
"field2": "bidang2",
"field3": "field3",
"field4": "field4",
"field5": "field5",
"field6": "field6",
"field7": "field7",
"field8": "bidang8",
"field9": "field9",
"field10": "301"
}][{
"dirName": "My Global",
"dirId": "00000000-0000-0000-0000-000000000000",
"dirType": "DirectoryContactMatch",
"contactId": "00000000-0000-0000-0000-000000000000",
"fields": {
"fullName": "Example Contact",
"companyName": "Company",
"jobTitle": "Job Title",
"email": "Email Address",
"field1": "field1",
"field2": "field2",
"field3": "field3",
"field4": "field4",
"field5": "field5",
"field6": "field6",
"field7": "field7",
"field8": "field8",
"field9": "field9",
"field10": "301"
}],
"tag": {
"Dukungan": "langkah 1"
}
},
"customData": {
"hook": "posting panggilan"
}
}