Incoming Webhook

This page has been moved to MiiTel Developers. Please see "Incoming Webhook" page.

Note that this page will not be updated in the future.

Dengan Incoming Webhook, Anda bisa integrasikan MiiTel dengan external phone system, dan manage, mengumpulkan data, dan menganalisis riwayat panggilan yang dibuat oleh external phone system di MiiTel Analytics

  Permissions or subscriptions required

  • Anda harus berlangganan kontrak terpisah. Jika Anda ingin menggunakan layanan ini, harap hubungi tim Sales terkait.
  • Hanya pengguna yang memiliki administrative privileges dapat mengonfigurasi pengaturan ini.

Contents

Sebelum menggunakan Incoming Webhook

Pertama, Anda perlu membuat URL yang akan Anda gunakan untuk mengatur Incoming Webhook.

  1. Kunjungi https://account.miitel.jp/v1/signin dan log in ke MiiTel Analytics.
  2. Klik cog-solid__1_.svg Open MiiTel Admin di kanan atas halaman.
  3. Klik Third Party Integration > Incoming Webhook.
  4. Klik Create URL.
  5. URL akan muncul di layar pengaturan.

Screenshot_2023-03-24_at_14.42.39.png

  NOTE

  •   Untuk satu company ID, Anda bisa buat satu URL.
  •   Jika Anda ingin membuat ulang URL, hapus URL dengan mengklik [ ellipsis-v-light__1_.svg ] > Delete, lalu klik Create URL again.

Selanjutnya, berikan izin kepada pengguna yang akan menggunakan Incoming Webhook, lalu terima User ID.

  1. Klik User > User List.
  2. Klik  ellipsis-v-light__1_.svg  pada user yang akan menggunakan Incoming Webhook > Edit.
  3. Cek Enable untuk menggunakan Incoming Webhook.
  4. Klik Save.

スクリーンショット 2023-11-28 17.09.11.png

  1. Klik  ellipsis-v-light__1_.svg  pada pengguna yang mendapat izin untuk menggunakan Incoming Webhook > Cek User ID.
  2. Klik Copy ID.

Screenshot_2023-03-24_at_14.43.55.png

Set up Incoming Webhook

1. Kirimkan request ke Incoming Webhook URL

Akses URL berikut dan periksa metode permintaan.

https://companyID_anda.miitel.jp/openapi/index.html#tag/CallWebhookPbx

(ganti your_companyID ke Company ID_anda.)

2. Upload audio file

Setelah Anda berhasil mengirim permintaan, Anda akan menerima URL untuk diunggah berkas audio. Anda dapat mengunggah format file berikut.

  • Audio channel: stereo, mono
  • File format: M4A, MP3, WAV

  IMPORTANT

  •   If the audio channel is mono, the speaker will be determined after the audio file is uploaded. Therefore, the speaker may be detected incorrectly in some parts of the conversation.

Kirim file audio dengan PUT di URL di atas.

Request

  Desktipsi
endpoint Menerima URL setelah Anda membuat call history
method PUT
param -
data File

Response

Status Description
200 Upload completed
403 URL salah atau lebih dari tiga jam telah berlalu sejak Anda mengirim permintaan, dan sesi telah berakhir

Setelah Anda menyelesaikan pengaturan di atas, silakan periksa apakah call history berhasil dibuat pada call history in MiiTel Analytics dan lihat apakah tidak ada kesalahan. Untuk kesalahan, harap periksa contoh di bawah ini untuk detailnya.

  • Jika Anda melihat pesan berikut Analytics engine is not started because the audio file has not been uploaded or is uploading, Anda mungkin belum menyelesaikan pengaturan 2. Upload the audio file atau unggahan file mungkin gagal.
  • Jika Anda melihat error message berikut Failed to Analyze data because of call duration is too short to analyze or a problem in recording,  ekstensi file audio dan file_type dari parameter mungkin tidak sama, atau mungkin ada yang salah dengan file tersebut.

Ganti pembicara di speech recognition results

Jika Anda mengirimkan permintaan upload file audio dengan "audio_channel_type": "MONAURAL", call history mungkin dibuat dengan ucapan user dan customer yang sebaliknya. (Jika pembicara ditentukan dengan benar, user akan ditampilkan dengan warna biru, dan customer akan ditampilkan dengan warna merah.

Jika speaker di call history sebaliknya, Anda dapat mengikuti langkah-langkah di bawah ini untuk mengganti speaker.

  1. Kunjungi https://account.miitel.jp/v1/signin dan log in ke MiiTel Analytics.
  2. Klik Call History headphones-solid.
  3. Pilih call history yang pembicaraan dari user dan customer yang berlawanan.
  4. Klik Operation yang terletak di atas kanan grafik > Tukar user dan customer.

  NOTE

  •  Jika Anda mengintegrasikan MiiTel dengan layanan dan pengaturan berikut untuk mendaftarkan speech recognition result ke layanan ini, Anda dapat menyimpan riwayat aktivitas dengan speech recognition result yang direvisi setelah mengklik Swap user and customer.
    Salesforce
    kintone
    HubSpot
  •  Jika Anda mengatur Slack notification rules berikut, Anda akan menerima notifikasi berikut setelah mengklik Swap user and customer.
    ・Saat speech recognition selesai:  Setelah Anda mengklik Swap user and customer, Anda akan menerima Slack notification. Notification akan termasuk speech recognition results dengan speaker yang ditukar.
    ・Sertakan speech recognition results (summary): Slack notification yang Anda terima setelah mengklik Swap user and customer will akan menyertakan summary dengan speaker yang ditukar.
  •  Jika Anda menggunakan Outgoing Webhook, call history dengan speech recognition result yang direvisi akan dikirimkan setelah mengklik Swap user and customer. Detail call history yang lama tidak akan ditimpa. 
  •  Jika Anda mengatur untuk menerima email notification setelah speech recognition selesai, Anda akan menerima email notification lain setelah mengklik Swap user and customer.

Additional information: Data format for requests

Format data untuk request pembuatan call history adalah sebagai berikut

"call_data": [
    {
        "call_data_id": str,
        "audio_file_type": str,
        "event_type": str,
        "groupname": str or null,
        "queue_name": str or null,
        "call_starts_at": str(datetime),
        "call_answered_at": str(datetime) or null,
        "call_ends_at": str(datetime),
        "circuit_number": str or null,
        "participants": [
            {
              "type": "FROM" or "TO",
              "stereo_lr": "left" or "right",
              "miitel_user_id": str or null,
              "number": str,
              "name": str or null
            }
        ],
        "tags": [
            {"value": str}
        ]
    }
]

  NOTE

  •   "miitel_user_id" diperlukan bergantung pada "event_type" dan "type" dari "participants".
"event_type" "miitel_user_id" (Required / Not required)
 

"type": “FROM“

"type": “TO“

OUTGOING_CALL:

Outgoing calls (external)

Required -

OUTGOING_TRANSFER:

Call transfer (external)

Required -

INCOMING_CALL:

Incoming calls (external)

- May be required *1

AUTOMATIC_TRANSFER:

Automatic call forwarding

- -

EXTENSION:

Extension calls to a user

Required

May be required *2

EXTENSION_TRANSFER:

Internal transfer to a user

Required

May be required *2

AUTOMATIC_RECORD:

Answering machine

- -

*1: Jika call_answered_at bukan null: Diharuskan

*2: Tidak ada group_name: Diharuskan
      Jika ada group_name: Diharuskan jika call_answered_at bukan null.

Apakah artikel ini membantu?