1. MiiTel Support
  2. MiiTel
  3. Third-party integrations
  4. If using an external web application
  1. MiiTel Support
  2. MiiTel
  3. If using an external web application
  4. Outgoing Webhook (video history)
  1. MiiTel Support
  2. MiiTel
  3. If using an external web application
  4. Outgoing Webhook (video history)

Outgoing Webhook (video history)

編集日:

Edited

Edited

This page has been moved to MiiTel Developers. Please see "Outgoing Webhook (meeting history)" page.

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

Outgoing Webhook (video history) sends an HTTP request to the configured URL (destination server of Webhook) after the following.

  • When the voice analysis of the video history is completed.

Engineers can use Webhook to integrate the video history details with the external systems.

Contents

How to integrate

  IMPORTANT

You can check the Challenge-Response in the following ways.

  •   When you Save the setting, add {'challenge':'hex_token'} to the setting and payload, and send a Challenge-Response confirmation request to the server set in [URL] (fixed IP address).
  •   The destination server must return a 'hex_token' value by a 200 response with a header of {'Content-Type':'text/plain'}.
  1. Visit https://account.miitel.jp/v1/signin and log in to MiiTel Analytics.
  2. Click cog-solid__1_.svg Open MiiTel Admin on the top right of the page.
  3. Click Third Party Integration > Outgoing Webhook.
  4. Click the Video history tab.
  5. Click Add new integration setting.

outwebhook_meeting1.png

  1. You will set the following fields.

outwebhook_meeting2.png

1Name: Enter the name of the setting. (E.g., a name that can recognize this integration)

2URL: (Destination server of Webhook)

3Additional headers: Enter the header you would like to add. (JSON format)

You will add the Bearer token or user authentication data for the BASIC authentication.
E.g., {”Authorization":"Bearer ACCESSTOKEN"}

  IMPORTANT

  •  You can not change 'User-Agent' and 'Content-Type'. They won't be reflected in this setting even if you set them.

4Additional payload: Enter the payload you would like to add. (JSON format)

  1. Click Save.

  NOTE

  •   If the confirmation cannot be made with Challenge-Response, you will see the following error messages and will not be able to save the integration setting.
    • If you do not receive the correct challenge value from the server.
      outgoingwebhook_challenge1.PNG
    • If you do not receive a response for a certain amount of time.
      outgoingwebhook_challenge2.PNG

How to edit the integration

  1. Visit https://account.miitel.jp/v1/signin and log in to MiiTel Analytics.
  2. Click cog-solid__1_.svg Open MiiTel Admin on the top right of the page.
  3. Click Third Party Integration > Outgoing Webhook.
  4. Click [ ellipsis-v-light__1_.svg ] on the integration setting > Edit.
  5. After you edit, click Save.

How to delete the integration

  1. Visit https://account.miitel.jp/v1/signin and log in to MiiTel Analytics.
  2. Click cog-solid__1_.svg Open MiiTel Admin on the top right of the page.
  3. Click Third Party Integration > Outgoing Webhook.
  4. Click [ ellipsis-v-light__1_.svg ] on the integration setting > Delete.
  5. Click Delete.

When Outgoing Webhook sends the HTTP request

  • When the voice analysis of the video history is completed.

HTTP request

Version

  • HTTP/1.1

Method

  • POST

Header

Key Description
content-type application/json; charset=utf-8
user-agent MiiTel-Webhook/v1

Payload

Key Description
video
 		Video history
  id



 		ID of the video history
The ID in the following URL (Video Analytics)
https://<Company ID>.miitel.jp/app/video/<Sequence ID>
  tenant_code
 		Company ID
  title Title of the video history
  platform

Service used for the meeting
zoom: Zoom
google_meet: Google Meet
microsoft_teams: Microsoft Teams
user_uploads: User upload
  starts_at Meeting start time (UTC)
  ends_at Meeting end time (UTC)
  access_permission

Access permission
EVERYONE: Everyone in the organization will have access.
HOST: The host will only have access.
HOST_AND_SELECTED_USER: The host and selected users will only have access.
  host Meeting host
    user_name MiiTel user name of the meeting host
    login_id MiiTel Login ID of the meeting host
  analysis Speech evaluation
    overlap_count Number of overlaps
    silence_count Number of silences
  participants Participants
    id ID of the speaker
    display_name Name of participants (guest<serial number> if the speaker can't be identified)
    miitel_user_name MiiTel user name ("null" if not linked to a MiiTel user)
    login_id MiiTel Login ID ("null" if not linked to a MiiTel user)
  speech_recognition
 		Speech recognition
    raw Speech recognition in order of the video history (original text)
    summary Speech recognition in order of the video history (summary)
Added payload's key Value of the added payload

Request sample

Request sample (You can click this link to download the request sample.)

{
    "video": {
        "id": "0188bd3f-0b93-c862-7edb-5ccd58b97866",
        "tenant_code": "miitel-test",
        "title": "demo sample",
        "platform": "zoom",
        "starts_at": "2023-06-15T04:10:04+00:00",
        "ends_at": "2023-06-15T04:11:44+00:00",
        "access_permission": "EVERYONE",
        "host": {
            "user_name": "三井照子",
            "login_id": "teruko.mitsui@miitel.jp"
        },
        "analysis": {
            "overlap_count": 0,
            "silence_count": 3
        },
        "participants": [
            {
                "id": "0188bd3f-e680-4b97-391d-0bb22c39ff3b",
                "display_name": "三井照子",
                "miitel_user_name": "teruko.mitsui",
                "login_id": "teruko.mitsui@miitel.jp"
            },
            {
                "id": "0188bd3f-1e8e-9f25-f456-ae1f190e4d77",
                "display_name": "Motoko Kondo",
                "miitel_user_name": null,
                "login_id": null
            }
        ],
        "speech_recognition": {
            "raw": "0:10 (Motoko Kondo) こんにちは、株式会社RevCommのミツイ様ですね、私はコンドウと申します。\n0:19 (三井 照子) 今日はお忙しい所お時間を割いて頂き、ありがとうございます。\n0:25 (Motoko Kondo) どうぞよろしくお願いいたします。\n0:30 (三井 照子) さて今日はMiiTelという音声解析ソリューションについて少しご説明させていただきたいと思っています。\n0:37 (三井 照子) 手元の資料に目を通していただいていると思うのですが、まずはご存知の通りMiiTelは弊社が開発した音声解析のための優れたプラットフォームです。\n0:46 (三井 照子) これによりお客様のコールセンターや営業部門などのコミュニケーション、業務効率化され、生産性が向上します。\n0:56 (Motoko Kondo) はい。確認しております。\n1:00 (三井 照子) っての企業でも、コールセンターの効率化と顧客対応の向上を図りたいと考えています。\n1:06 (三井 照子) MiiTelは自然言語処理技術を活用して、通話の内容はテキストに変換し、重要なキーワードがトレンド把握する事ができます。\n1:14 (三井 照子) これにより、顧客との会話の中で何が起こっているのがより深い、どう伝える事が出来るんです。\n1:20 (三井 照子) さらに録音された通話をリアルタイムで監視する事も可能で、トレーニングやフィードバックに役立てられます。",
            "summary": "0:10 (Motoko Kondo) こんにちは、株式会社RevCommのミツイ様ですね、私はコンドウと申します。\n0:25 (Motoko Kondo) どうぞよろしくお願いいたします。\n0:37 (三井 照子) 手元の資料に目を通していただいていると思うのですが、まずはご存知の通りMiiTelは弊社が開発した音声解析のための優れたプラットフォームです。\n0:46 (三井 照子) これによりお客様のコールセンターや営業部門などのコミュニケーション、業務効率化され、生産性が向上します。\n0:56 (Motoko Kondo) はい。確認しております。\n1:06 (三井 照子) MiiTelは自然言語処理技術を活用して、通話の内容はテキストに変換し、重要なキーワードがトレンド把握する事ができます。\n1:20 (三井 照子) さらに録音された通話をリアルタイムで監視する事も可能で、トレーニングやフィードバックに役立てられます。"
        }
    },
    "params_key": "z&aH+&Kz8saC"
}

Was this article helpful?

If using an external web application

Related articles

If using an external web application