Outgoing Webhook 会議履歴は、設定した URL (Webhook 送信先サーバー) に HTTP リクエストを以下のタイミングで送信できます。
- 会議履歴の音声分析完了時
開発者は、Webhook を利用して外部システムへ MiiTel 会議履歴情報を連携できます。
連携を設定する
IMPORTANT
Challenge-Response を以下の方法で確認できます。
- 設定保存時、設定内容とペイロードに {'challenge':'hex_token'} を付与し、固定 IP アドレスで [URL] に設定したサーバーに Challenge-Response 方式の確認リクエストを送信します。
- リクエスト送信先サーバーは、ヘッダーを {'Content-Type':'text/plain'} とした 200 レスポンスで 'hex_token' 値を返す必要があります。
- https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
-
画面右上の
[MiiTel Admin を開く] をクリックします。
- [外部連携] > [Outgoing Webhook] をクリックします。
- [会議履歴] タブをクリックします。
- [連携設定を追加] をクリックします。
- 各項目を設定します。
1名前: 作成する設定の名前を入力する (連携先が分かるような名前など)
2URL: Webhook 送信先サーバーの URL を入力する
3追加ヘッダー: 追加したいヘッダーを JSON 形式で入力する
BASIC 認証のためのユーザー認証用データ、Bearer トークンなどを追加できます。
例) {”Authorization":"Bearer ACCESSTOKEN"}
IMPORTANT
- 'User-Agent'、'Content-Type' は変更できません。設定した場合、反映されません。
4追加ペイロード: 追加したいペイロードを JSON 形式で入力する
- [保存] をクリックします。
NOTE
-
Challenge-Response 方式による確認ができなかった場合、以下のエラーメッセージが表示され設定を保存できません。
- サーバーから正しい challenge 値が返らなかった場合
- 一定時間レスポンスが返らなかった場合
- サーバーから正しい challenge 値が返らなかった場合
設定を編集する
- https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
-
画面右上の
[MiiTel Admin を開く] をクリックします。
- [外部連携] > [Outgoing Webhook] をクリックします。
- 編集したい設定右横の
> [編集] をクリックします。
- 編集後、[保存] をクリックします。
設定を削除する
- https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
-
画面右上の
[MiiTel Admin を開く] をクリックします。
- [外部連携] > [Outgoing Webhook] をクリックします。
- 削除したい設定右横の
> [削除] をクリックします。
- [削除] をクリックします。
HTTP リクエスト送信タイミング
- 会議履歴の音声分析完了時
HTTP リクエスト
バージョン
- HTTP/1.1
メソッド
- POST
ヘッダー
キー | 説明 |
---|---|
content-type | application/json; charset=utf-8 |
user-agent | MiiTel-Webhook/v1 |
ペイロード
キー | 説明 | ||||
---|---|---|---|---|---|
video |
会議履歴 | ||||
id |
会議履歴を識別する ID MiiTel Analytics 会議履歴 URL の以下 https://<企業ID>.miitel.jp/app/video/<シーケンス ID> |
||||
tenant_code |
企業 ID | ||||
title | 会議履歴のタイトル | ||||
platform |
会議を実施したサービス |
||||
starts_at | 会議開始時刻 (UTC) | ||||
ends_at | 会議終了時刻 (UTC) | ||||
access_permission |
閲覧制限 |
||||
host | 会議のホスト | ||||
user_name | 会議ホストの MiiTel ユーザー名 | ||||
login_id | 会議ホストの MiiTel ログイン ID | ||||
analysis | 応対評価 | ||||
overlap_count | 被り回数 | ||||
silence_count | 沈黙回数 | ||||
participants | 参加者 | ||||
id | 発話者を識別する ID | ||||
display_name | 会議参加名 (発話者が特定できない場合は guest<通し番号>) | ||||
miitel_user_name | MiiTel ユーザー名 (MiiTel ユーザーと連携していない場合は null) | ||||
login_id | MiiTel ログイン ID (MiiTel ユーザーと連携していない場合は null) | ||||
speech_recognition |
音声認識 | ||||
raw | 会議履歴発話順の音声認識 (フィラーを除いた文) | ||||
summary | 会議履歴発話順の音声認識 (要約) | ||||
追加したペイロードのキー | 追加したペイロードの値 |
リクエストサンプル
リクエストサンプル (以下のリクエストサンプルをダウンロードできます)
{
"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"
}