Outgoing Webhook 応対履歴

このページは MiiTel Developers に移行しました。「Outgoing Webhook 応対履歴の仕様と利用方法」を確認してください。

今後、このページは更新されないため、ご注意ください。

Outgoing Webhook は、設定した URL (Webhook 送信先サーバー) に HTTP リクエストを以下のタイミングで送信します。

  • 応対履歴の音声認識終了時
  • MiiTel に設定した IVR の番号を発信元が入力した時
  • 不在着信時
  • 不在発信時
  • プレディクティブコールの不在発信時
  • 自動転送先が不在時
  • 議事録作成完了時

開発者は、Webhook を利用して外部システムへ MiiTel 応対履歴情報を連携できます。

  この機能を利用するには ?

目次

連携を設定する

  IMPORTANT

Challenge-Response を以下の方法で確認できます。

  •   設定保存時、設定内容とペイロードに {'challenge':'hex_token'} を付与し、固定 IP アドレスで [URL] に設定したサーバーに Challenge-Response 方式の確認リクエストを送信します。
  •   リクエスト送信先サーバーは、ヘッダーを {'Content-Type':'text/plain'} とした 200 レスポンスで 'hex_token' 値を返す必要があります。 
  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上の cog-solid [MiiTel Admin を開く] をクリックします。

  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. [応対履歴連携設定を追加] をクリックします。

OutgoindWebhook1%2B%2B.png

  1. 各項目を設定します。

応対履歴連携.png

1名前: 作成する設定の名前を入力 (連携先が分かるような名前など)

2URL: Webhook 送信先サーバーの URL を入力する

3追加ヘッダー: 追加したいヘッダーを JSON 形式で入力する

BASIC 認証のためのユーザー認証用データや、Bearer トークンなどを追加できます。
例) {”Authorization":"Bearer ACCESSTOKEN"}

  IMPORTANT

  •  'User-Agent'、'Content-Type' は変更できません。設定した場合、反映されません。

4追加ペイロード: 追加したいペイロードを JSON 形式で入力する

5音声認識フレーズ: 音声認識結果のフレーズをペイロードに含めない場合はチェックを入れる

6音声認識キーワード: 音声認識結果のキーワードをペイロードに含めない場合はチェックを入れる

7送信元 IP アドレス: 送信元 IP アドレスを固定する場合はチェックを入れる

  • MiiTel がリクエスト送信に利用する送信元 IP アドレスは以下のいずれかです。
    • 18.177.83.94/32
    • 35.73.236.241/32
  • 固定した場合、毎時 0, 10, 20, 30, 40, 50 分に過去 10 分間の応対履歴のリクエストを一括送信します。

8通知ルール: リクエストを送信したいタイミングに応じてチェックを入れる

  • 音声認識終了時にチェックを入れた場合、以下のタイミングでリクエストが送信されます。
    • 応対履歴の音声認識終了時
    • MiiTel に設定した IVR の番号を発信元が入力した時
    • 不在着信時
    • 不在発信時
    • プレディクティブコールの不在発信時
    • 自動転送先が不在時
  •  議事録作成完了時にチェックを入れた場合、以下のタイミングでリクエストが送信されます。
    • 議事録作成完了時
  1. [保存] をクリックします。

  NOTE

  •   Challenge-Response方式による確認ができなかった場合、以下のエラーメッセージが表示され設定を保存できません。
    • サーバーから正しい challenge 値が返らなかった場合
      outgoingwebhook_challenge1.PNG
    • 一定時間レスポンスが返らなかった場合
      outgoingwebhook_challenge2.PNG

設定を編集する

  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上のcog-solid [MiiTel Admin を開く] をクリックします。

  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. 編集したい設定右横の [ ellipsis-v-light__1_.svg ] > [編集] をクリックします。
  5. 編集後、[保存] をクリックします。

OutgoindWebhook3%2B%2B.PNG

設定を削除する

  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上の cog-solid [MiiTel Admin を開く] をクリックします。

  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. 削除したい設定右横の [ ellipsis-v-light__1_.svg ] > [削除] をクリックします。
  5. [削除] をクリックします。

OutgoindWebhook4%2B%2B.PNG

HTTP リクエスト送信タイミング

  • 連携を設定する」で音声認識終了時にチェックを入れた場合、以下のタイミングでリクエストが送信されます。
    • 応対履歴の音声認識終了時
    • MiiTel に設定した IVR の番号を発信元が入力した時
    • 不在着信時
    • 不在発信時
    • プレディクティブコールの不在発信時
    • 自動転送先が不在時
  • 連携を設定する」で議事録作成完了時にチェックを入れた場合、以下のタイミングでリクエストが送信されます。
    • 議事録作成完了時

HTTP リクエスト

バージョン

  • HTTP/1.1

メソッド

  • POST

ヘッダー

キー 説明
content-type application/json; charset=utf-8
user-agent MiiTel-Webhook/v1

ペイロード

リクエストサンプル

以下のリクエストサンプルをダウンロードできます。

音声認識終了時にチェックを入れた場合のリクエストサンプル

{
"call": {
"id": "0184f502-8b5f-b967-10c1-625c89785630",
"tenant_code": "miitel-test",
"details": [
{
"id": "0184f502-8b5f-b967-10c1-625c89785630",
"dial_starts_at": "2022-12-09T03:41:48+00:00",
"dial_answered_at": "2022-12-09T03:41:54+00:00",
"dial_ends_at": "2022-12-09T03:42:17+00:00",
"queueing_starts_at": null,
"queueing_answered_at": null,
"queueing_ends_at": null,
"call_type": "OUTGOING_CALL",
"circuit_number": "050-0000-0000",
"circuit_name": "050-0000-0000",
"from_number": null,
"to_number": "050-9999-9999",
"previous_id": null,
"dtmf": "0",
"analysis": {
"score": 313.3515187539091,
"tlr": 0.8095,
"rally_count": 5,
"overlap_count": 0,
"silence_count": 1,
"silence_positions": [[9.43,13.38]],
"overlap_positions": []
},
"participants": [
{
"id": "0184f502-8b66-4ab1-10d3-34c0049a9100",
"from_to": "FROM",
"name": "鈴木 太郎",
"company_name": null,
"analysis": {
"f0": 116.8819,
"speechrate": 8.8416,
"variance": 22.803,
"filler_count": 2,
"positive_score": 0,
"negative_score": 0
}
},
{
"id": "0184f502-8b66-1a28-3896-550ac23b8e34",
"from_to": "TO",
"name": null,
"company_name": null,
"analysis": {
"f0": 234.0116,
"speechrate": 6.3676,
"variance": null,
"filler_count": 5,
"positive_score": 0,
"negative_score": 0
}
}
],
"tags": [
{
"created_by": "鈴木 太郎",
"creator_type": "TENANT_USER",
"value": "大項目①"
},
{
"created_by": "鈴木 太郎",
"creator_type": "TENANT_USER",
"value": "詳細項目①"
}
],
"comments": [
{
"created_at": "2022-12-09T04:45:13.732021+00:00",
"created_by": "鈴木 太郎",
"value": "コメント"
}
],
"keywords": [
{
"starts_at": 2,
"participant_id": "0184f502-8b66-1a28-3896-550ac23b8e34",
"value": "みーてる"
},
{
"starts_at": 2,
"participant_id": "0184f502-8b66-1a28-3896-550ac23b8e34",
"value": "でんわ"
}
],
"phrases": [
{
"participant_id": "0184f502-8b66-1a28-3896-550ac23b8e34",
"raw": [
{
"order": 1,
"phrase": "お世話になります。IP電話ミーテルの鈴木と申します。",
"phrase_nofiller": "お世話になります。IP電話ミーテルの鈴木と申します。",
"start_at": 2.16,
"end_at": 5.345,
"filler_num": 0
},
{
"order": 3,
"phrase": "恐れ入ります、高橋様お手すきでいらっしゃいますか。",
"phrase_nofiller": "恐れ入ります、高橋様お手すきでいらっしゃいますか。",
"start_at": 6.835,
"end_at": 9.425,
"filler_num": 0
},
{
"order": 4,
"phrase": "あっそうだったんですね。わかりました。また来週改めさしていただきます。",
"phrase_nofiller": "そうだったんですね。わかりました。また来週改めさしていただきます。",
"start_at": 13.39,
"end_at": 17.935,
"filler_num": 1
},
{
"order": 6,
"phrase": "はい、よろしくお願いいたしますー。",
"phrase_nofiller": "よろしくお願いいたしますー。",
"start_at": 18.85,
"end_at": 20.745,
"filler_num": 1
}
],
"summary": [
{
"order": 1,
"phrase": "お世話になります。IP電話ミーテルの鈴木と申します。",
"phrase_nofiller": "お世話になります。IP電話ミーテルの鈴木と申します。",
"start_at": 2.16,
"end_at": 5.345,
"filler_num": null
},
{
"order": 3,
"phrase": "恐れ入ります、高橋様お手すきでいらっしゃいますか。",
"phrase_nofiller": "恐れ入ります、高橋様お手すきでいらっしゃいます��。",
"start_at": 6.835,
"end_at": 9.425,
"filler_num": null
},
{
"order": 4,
"phrase": "あっそうだったんですね。わかりました。また来週改めさしていただきます。",
"phrase_nofiller": "そうだったんですね。わかりました。また来週改めさしていただきます。",
"start_at": 13.39,
"end_at": 17.935,
"filler_num": null
}
]
},
{
"participant_id": "0184f502-8b66-4ab1-10d3-34c0049a9100",
"raw": [
{
"order": 0,
"phrase": "はい。結構ですー。",
"phrase_nofiller": "結構ですー。",
"start_at": 0.545,
"end_at": 2.025,
"filler_num": 1
},
{
"order": 2,
"phrase": "はい。お世話になります。",
"phrase_nofiller": "お世話になります。",
"start_at": 5.555,
"end_at": 7.05,
"filler_num": 1
},
{
"order": 5,
"phrase": "あっ、はい。お願いしまーす。",
"phrase_nofiller": "お願いしす。",
"start_at": 17.07,
"end_at": 19.03,
"filler_num": 3
}
],
"summary": [
{
"order": 0,
"phrase": "はい。結構ですー。",
"phrase_nofiller": "結構ですー。",
"start_at": 0.545,
"end_at": 2.025,
"filler_num": null
},
{
"order": 2,
"phrase": "はい。お世話になります。",
"phrase_nofiller": "お世話になります。",
"start_at": 5.555,
"end_at": 7.05,
"filler_num": null
},
{
"order": 5,
"phrase": "あっ、はい。お願いしまーす。",
"phrase_nofiller": "お願いしす。",
"start_at": 17.07,
"end_at": 19.03,
"filler_num": null
}
]
}
],
"speech_recognition": {
"raw": "0:00 (ユーザー) 結構ですー。\n0:02 (取引先) お世話になります。IP電話ミーテルの鈴木と申します。\n0:05 (ユーザー) お世話になります。\n0:06 (取引先) 恐れ入ります、高橋様お手すきでいらっしゃいますか。\n0:13 (取引先) そうだったんですね。わかりました。また来週改めさしていただきます。\n0:17 (ユーザー) お願いしす。\n0:18 (取引先) よろしくお願いいたしますー。",
"summary": "0:00 (ユーザー) 結構ですー。\n0:02 (取引先) お世話になります。IP電話ミーテルの鈴木と申します。\n0:05 (ユーザー) お世話になります。\n0:06 (取引先) 恐れ入ります、高橋様お手すきでいらっしゃいますか。\n0:13 (取引先) そうだったんですね。わかりました。また来週改めさしていただきます。\n0:17 (ユーザー) お願いしす。"
}
}
]
},
"params_key": "z&aH+&Kz8saC"
}

 

議事録作成完了時にチェックを入れた場合のリクエストサンプル

{
    "call": {
        "id": "d5d7acf0-61cf-4016-9fe6-44a530d29898",
        "tenant_code": "miitel-test",
        "details": [
            {
                "id": "d5d7acf0-61cf-4016-9fe6-44a530d29898",
                "dial_starts_at": "2023-10-17T14:08:17+00:00",
                "dial_answered_at": "2023-10-17T14:08:22+00:00",
                "dial_ends_at": "2023-10-17T14:36:50+00:00",
                "queueing_starts_at": null,
                "queueing_answered_at": null,
                "queueing_ends_at": null,
                "call_type": "OUTGOING_CALL",
                "circuit_number": "050-0000-0000”,
                "circuit_name": "050-0000-0000”,
                "from_number": null,
                "to_number": "050-“9999-9999,
                "previous_id": null,
                "minutes": "【議題】\n- 新しいシステムの導入について\n\n【重要なポイント】\n- パソコンとヘッドセットがあればどこでも電話がかけられる\n- 通話内容が録音され解析される\n- 解析結果はウェブアプリケーション上で表示され、取引先との通話日時や通話時間、オペレーターと顧客の会話の割合などが分析される\n- キーワードの出現回数やオペレーターと顧客の会話の速度も測定される\n- システムの利用方法について具体的な例が示される\n- 会議の記録をテキストベースで残すことができ、営業マンはお客様の要望を確認し、自動的に入力することができる\n- 会議内容を共有し、要約された情報を確認することができる\n- AIによる文字起こし機能が開発されており、営業活動や英語の収集にも活用できる\n- テキストをコピーして別の文書に埋め込むことも可能\n- 電話の応対履歴や結果が表示・ダウンロード可能\n- お客様情報をインポートし、電話でのコミュニケーションも可能\n- 新入社員や部署の変更にも対応しており、作業は不要\n- グループ分けや着信ルール管理も可能\n- 自動暗号化や留守番電話の設定など、携帯電話や固定電話の転送機能について話し合われた\n- 営業マンの登録や営業の振り返りについて議論があり、営業現場でのツールとしての活用方法が提案された\n- トップセールスの方々がスコアリングを導入し、営業成績を振り返ることができるという話もあった\n- 営業の改善やお客様との会話の確認ができるようになり、営業スタイルの改善に役立つことが示された\n- 電話セールスの重要性や営業部署での活用について話し合われた\n- 医療会社やカスタマーサポートなど、さまざまな業界での利用例が話された\n- 新規営業にこだわる必要はないとの意見もあった\n- 文字起こしや可視化の重要性についても話され、参加者はそのシステムに魅力を感じていた\n- システムへのアクセス権限に関する問題があったため、再度アクセス権限の付与を依頼することになった\n- 広告運営やセキュリティに関する問題も話し合われ、解決策を見つけるためにさらなる調査が必要とされた\n\n【今後取るべき方針】\n- アクセス権限の問題を解決するために再度付与依頼を行う\n- 広告運営やセキュリティに関する調査を行い、問題の解決策を見つける\n- システムの利用方法を営業マンに周知し、営業現場での活用を促進する\n- 参加者への質問や要望に対して連絡する",
                "participants": [
                    {
                        "id": "018b3e18-3e27-156c-7585-40b59e7c92f4",
                        "from_to": "FROM",
                        "name": “鈴木 太郎”,
                        "company_name": null,
                        "login_id": taro.suzuki@revcomm.co.jp,
                    },
                    {
                        "id": "018b3e18-3e28-f801-092a-f2fbc3f44b5f",
                        "from_to": "TO",
                        "name": "レブコム太郎",
                        "company_name": "レブコム商事",
                        "login_id": "null",
                    }
                ]
            }
        ]
    },
"params_key": "z&aH+&Kz8saC"
}

この記事は役に立ちましたか?