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 OK のレスポンスで 'hex_token' 値を返す必要があります。
    ※ 'hex_token' のみを返却ください。
  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上の [MiiTel Admin を開く] をクリックします。
  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. [応対履歴連携設定を追加] をクリックします。
  1. 各項目を設定します。

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

[2] URL: 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
    • 13.115.206.234/32
    • 13.230.53.90/32
    • 57.180.141.15/32
    • 固定した場合、毎時 0, 10, 20, 30, 40, 50 分に過去 10 分間の応対履歴のリクエストを一括送信します
  • リアルタイム文字起こし終了時、リアルタイム議事録作成完了時
    • 18.177.199.236/32
    • 18.180.205.132/32
    • 54.199.140.139/32
    • 57.180.97.63/32
    • 54.65.211.64/32
    • リアルタイム文字起こし終了時とリアルタイム議事録作成完了時はチェックをいれなくても常に固定になり、随時送信されます

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

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

📘

NOTE

Challenge-Response方式による確認ができなかった場合、以下のエラーメッセージが表示され設定を保存できません。

  • サーバーから正しい challenge 値が返らなかった場合

  • 一定時間レスポンスが返らなかった場合

設定を編集する

  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上の [MiiTel Admin を開く] をクリックします。
  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. 編集したい設定右横の [ ellipsis-v-light__1_.svg ] > [編集] をクリックします。
  5. 編集後、[保存] をクリックします。

設定を削除する

  1. https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
  2. 画面右上の [MiiTel Admin を開く] をクリックします。
  3. [外部連携] > [Outgoing Webhook] をクリックします。
  4. 削除したい設定右横の [ ellipsis-v-light__1_.svg ] > [削除] をクリックします。
  5. [削除] をクリックします。

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

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

HTTP リクエスト

バージョン

  • HTTP/1.1

メソッド

  • POST

ヘッダー

キー
content-typeapplication/json; charset=utf-8
user-agentMiiTel-Webhook/v1

ペイロード(リクエストボディー)の JSON Schema

{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$ref": "#/definitions/Welcome",
    "definitions": {
        "Welcome": {
            "type": "object",
            "additionalProperties": true,
            "properties": {
                "call": {
                    "$ref": "#/definitions/Call"
                }
            },
            "required": [
                "call"
            ],
            "title": "Welcome"
        },
        "Call": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "tenant_code": {
                    "type": "string"
                },
                "details": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Detail"
                    }
                }
            },
            "required": [
                "id",
                "tenant_code",
                "details"
            ],
            "title": "Call"
        },
        "Detail": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "dial_starts_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "dial_answered_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "dial_ends_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "queueing_starts_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "queueing_answered_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "queueing_ends_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "call_type": {
                    "type": "string",
                    "enum": [
                        "EXTENSION",
                        "EXTENSION_GROUP",
                        "OUTGOING_CALL",
                        "PREDICTIVE_DIAL",
                        "INCOMING_CALL",
                        "INCOMING_CALL_USER",
                        "QUEUEING_CALL",
                        "AUTOMATIC_TRANSFER",
                        "EXTENSION_TRANSFER",
                        "EXTENSION_GROUP_TRANSFER",
                        "AUTOMATIC_RECORD",
                        "OUTGOING_TRANSFER",
                        "READ_DTMF"
                    ]
                },
                "circuit_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "circuit_name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "from_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "to_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "previous_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "uuid"
                },
                "dtmf": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "integer"
                },
                "analysis": {
                    "$ref": "#/definitions/DetailAnalysis"
                },
                "participants": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Participant"
                    }
                },
                "tags": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Tag"
                    }
                },
                "comments": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Comment"
                    }
                },
                "keywords": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Keyword"
                    }
                },
                "phrases": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Phrase"
                    }
                },
                "speech_recognition": {
                    "$ref": "#/definitions/SpeechRecognition"
                }
            },
            "required": [
                "analysis",
                "call_type",
                "circuit_name",
                "circuit_number",
                "comments",
                "dial_answered_at",
                "dial_ends_at",
                "dial_starts_at",
                "dtmf",
                "from_number",
                "id",
                "keywords",
                "participants",
                "phrases",
                "previous_id",
                "queueing_answered_at",
                "queueing_ends_at",
                "queueing_starts_at",
                "speech_recognition",
                "tags",
                "to_number"
            ],
            "title": "Detail"
        },
        "DetailAnalysis": {
            "type": [
                "object",
                "null"
            ],
            "additionalProperties": false,
            "properties": {
                "score": {
                    "type": "number"
                },
                "tlr": {
                    "type": "number"
                },
                "rally_count": {
                    "type": "integer"
                },
                "overlap_count": {
                    "type": "integer"
                },
                "silence_count": {
                    "type": "integer"
                },
                "silence_positions": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "items": {
                            "type": "number"
                        },
                        "minItems": 2,
                        "maxItems": 2
                    }
                },
                "overlap_positions": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "items": {
                            "type": "number"
                        },
                        "minItems": 2,
                        "maxItems": 2
                    }
                }
            },
            "required": [
                "overlap_count",
                "overlap_positions",
                "rally_count",
                "score",
                "silence_count",
                "silence_positions",
                "tlr"
            ],
            "title": "DetailAnalysis"
        },
        "Comment": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "created_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "created_by": {
                    "type": "string"
                },
                "value": {
                    "type": "string"
                }
            },
            "required": [
                "created_at",
                "created_by",
                "value"
            ],
            "title": "Comment"
        },
        "Keyword": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "starts_at": {
                    "type": "integer"
                },
                "participant_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "value": {
                    "type": "string"
                }
            },
            "required": [
                "participant_id",
                "starts_at",
                "value"
            ],
            "title": "Keyword"
        },
        "Participant": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "from_to": {
                    "type": "string",
                    "enum": [
                        "FROM",
                        "TO"
                    ]
                },
                "name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "company_name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "analysis": {
                    "$ref": "#/definitions/ParticipantAnalysis"
                }
            },
            "required": [
                "analysis",
                "company_name",
                "from_to",
                "id",
                "name"
            ],
            "title": "Participant"
        },
        "ParticipantAnalysis": {
            "type": [
                "object",
                "null"
            ],
            "additionalProperties": false,
            "properties": {
                "f0": {
                    "type": "number"
                },
                "speechrate": {
                    "type": "number"
                },
                "variance": {
                    "type": [
                        "number",
                        "null"
                    ]
                },
                "filler_count": {
                    "type": "integer"
                },
                "positive_score": {
                    "type": "integer"
                },
                "negative_score": {
                    "type": "integer"
                }
            },
            "required": [
                "f0",
                "filler_count",
                "negative_score",
                "positive_score",
                "speechrate",
                "variance"
            ],
            "title": "ParticipantAnalysis"
        },
        "Phrase": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "participant_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "raw": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Raw"
                    }
                },
                "summary": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Raw"
                    }
                }
            },
            "required": [
                "participant_id",
                "raw",
                "summary"
            ],
            "title": "Phrase"
        },
        "Raw": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "order": {
                    "type": "integer"
                },
                "phrase": {
                    "type": "string"
                },
                "phrase_nofiller": {
                    "type": "string"
                },
                "start_at": {
                    "type": "number"
                },
                "end_at": {
                    "type": "number"
                },
                "filler_num": {
                    "type": [
                        "integer",
                        "null"
                    ]
                }
            },
            "required": [
                "end_at",
                "filler_num",
                "order",
                "phrase",
                "phrase_nofiller",
                "start_at"
            ],
            "title": "Raw"
        },
        "SpeechRecognition": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "raw": {
                    "type": "string"
                },
                "summary": {
                    "type": "string"
                }
            },
            "required": [
                "raw",
                "summary"
            ],
            "title": "SpeechRecognition"
        },
        "Tag": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "created_by": {
                    "type": "string"
                },
                "creator_type": {
                    "type": "string",
                    "enum": [
                        "TENANT_USER",
                        "SYSTEM"
                    ]
                },
                "value": {
                    "type": "string"
                }
            },
            "required": [
                "created_by",
                "creator_type",
                "value"
            ],
            "title": "Tag"
        }
    }
}
{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$ref": "#/definitions/Welcome",
    "definitions": {
        "Welcome": {
            "type": "object",
            "additionalProperties": true,
            "properties": {
                "call": {
                    "$ref": "#/definitions/Call"
                }
            },
            "required": [
                "call"
            ],
            "title": "Welcome"
        },
        "Call": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "tenant_code": {
                    "type": "string"
                },
                "details": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Detail"
                    }
                }
            },
            "required": [
                "id",
                "tenant_code",
                "details"
            ],
            "title": "Call"
        },
        "Detail": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "dial_starts_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "dial_answered_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "dial_ends_at": {
                    "type": "string",
                    "format": "date-time"
                },
                "queueing_starts_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "queueing_answered_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "queueing_ends_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "call_type": {
                    "type": "string",
                    "enum": [
                        "EXTENSION",
                        "EXTENSION_GROUP",
                        "OUTGOING_CALL",
                        "PREDICTIVE_DIAL",
                        "INCOMING_CALL",
                        "INCOMING_CALL_USER",
                        "QUEUEING_CALL",
                        "AUTOMATIC_TRANSFER",
                        "EXTENSION_TRANSFER",
                        "EXTENSION_GROUP_TRANSFER",
                        "AUTOMATIC_RECORD",
                        "OUTGOING_TRANSFER"
                    ]
                },
                "circuit_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "circuit_name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "from_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "to_number": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "previous_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "uuid"
                },
                "participants": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Participant"
                    }
                },
                "minutes": {
                    "type": "string"
                }
            },
            "required": [
                "call_type",
                "circuit_name",
                "circuit_number",
                "dial_answered_at",
                "dial_ends_at",
                "dial_starts_at",
                "from_number",
                "id",
                "participants",
                "previous_id",
                "queueing_answered_at",
                "queueing_ends_at",
                "queueing_starts_at",
                "to_number",
                "minutes"
            ],
            "title": "Detail"
        },
        "Participant": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "from_to": {
                    "type": "string",
                    "enum": [
                        "FROM",
                        "TO"
                    ]
                },
                "name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "company_name": {
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "login_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "email"
                }
            },
            "required": [
                "company_name",
                "from_to",
                "id",
                "name"
            ],
            "title": "Participant"
        }
    }
}

ペイロード(リクエストボディー)の内容

文字起こし終了時にチェックを入れた場合

キー 説明
call
応対履歴
  id

親となる応対履歴を識別する ID
(連続した一連の応対履歴には同じ ID が設定される)
  tenant_code
企業 ID
  
details
応対履歴の詳細
    id
応対履歴を識別する ID
MiiTel Analytics 応対履歴 URL の以下
https://<企業ID>.miitel.jp/app/calls/<シーケンス ID>
     dial_starts_at
ダイヤル開始時刻
     dial_answered_at
通話開始時刻
     dial_ends_at
通話終了時刻
     queueing_starts_at
着信がキューに入った時刻
     queueing_answered_at
キューに入っていた着信にユーザーが応答した時刻。または、プレディクティブコールの発信先が応答した時刻
     queueing_ends_at
キューに入っていた着信が切れた時刻、または、通話終了した時刻
       call_type


通話種別
OUTGOING_CALL: 外線発信
OUTGOING_TRANSFER: 外線転送
INCOMING_CALL: 外線着信
QUEUEING_CALL: キューイング着信
EXTENSION: ユーザー宛内線
EXTENSION_GROUP: グループ宛内線
EXTENSION_TRANSFER: ユーザー宛内線転送
EXTENSION_GROUP_TRANSFER: グループ宛内線転送

PREDICTIVE_DIAL: プレディクティブコール
AUTOMATIC_TRANSFER: 自動転送
AUTOMATIC_RECORD: 留守番電話
READ_DTMF: IVR プッシュ番号
INCOMING_CALL_USER: 特定ユーザーへの外線着信

     circuit_number
回線番号
     circuit_name
回線名
    from_number
発信元電話番号
発信の場合は null、発信時は circuit_number を確認
     to_number
発信先電話番号
     previous_id
直前のアクションのシーケンス ID (直前のアクションがない場合は null)
     dtmf
IVR で選択された番号
     analysis
応対評価
      score
全体スコア
      tlr

Talk : Listen 比率

       rally_count
ラリー回数
      overlap_count
被り回数
      silence_count
沈黙回数
      silence_positions

沈黙区間

  • 開始時間 (秒)、完了時間 (秒) のペアの配列として表現
    • 例: [[5.23, 7.53], [15.2, 33.91]]
      overlap_positions 被り区間
  • 開始時間 (秒)、完了時間 (秒) のペアの配列として表現
    • 例: [[5.23, 7.53], [15.2, 33.91]]
    participants
発話者
       id
発話者を識別する ID
      from_to

FROM: 発信元
TO: 発信先

      name
発話者名
MiiTel ユーザー名
または、MiiTel 連絡先に登録されている取引先担当者名 (連絡先に登録ない場合は null)
      company_name
取引先会社名
       analysis
音声評価
        f0 基本周波数
        speechrate 話速
        variance 抑揚の強弱
        filler_count フィラー回数
        positive_score 感情認識 ポジティブスコア
0 ~ 1 の値 (1 が最大値)
        negative_score 感情認識 ネガティブスコア
0 ~ 1 の値 (1 が最大値)
    tags
応対メモ
      created_by
応対メモを登録した MiiTel ユーザー
      creator_type
TENANT_USER: 応対メモ
SYSTEM: 自動応対メモ
      value
応対メモ項目 (登録応対メモの値)
    comments
コメント
      created_at
コメント登録日
      created_by
コメント登録ユーザー
      value
コメントの内容
    keywords
キーワード出現
      starts_at
キーワード出現時刻  (通話開始からの経過時間 (秒) )
      participant_id
キーワードの発話者の発話者 ID (participant > id)
      value
キーワードの値
    phrases
音声認識結果 
      participant_id
発話者 ID (participant > id)
      raw
発話者の発話音声認識
         order 発話の通し番号 (0~)
        phrase 発話の音声認識 (原文)
        phrase_nofiller

発話の音声認識 (フィラーを除いた文)

        start_at 発話開始時の時刻 (通話開始からの経過時間 (秒))
        end_at 発話終了時の時刻 (通話開始からの経過時間 (秒))
        filler_num 発話音声認識からフィラー除去した文字数
      summary 音声認識 (要約文)
設定されているキーは details > phrases > raw と同じ
    speech_recognition
音声認識
      raw
応対履歴発話順の音声認識 (フィラーを除いた文)
      summary
応対履歴発話順の音声認識 (要約)
追加したペイロードのキー 追加したペイロードの値

議事録作成完了時にチェックを入れた場合

キー 説明
call
応対履歴
  id

親となる応対履歴を識別する ID
(連続した一連の応対履歴には同じ ID が設定される)
  tenant_code
企業 ID
  
details
応対履歴の詳細
    id
応対履歴を識別する ID
MiiTel Analytics 応対履歴 URL の以下
https://<企業ID>.miitel.jp/app/calls/<シーケンス ID>
     dial_starts_at
ダイヤル開始時刻
     dial_answered_at
通話開始時刻
     dial_ends_at
通話終了時刻
     queueing_starts_at
着信がキューに入った時刻
     queueing_answered_at
キューに入っていた着信にユーザーが応答した時刻。または、プレディクティブコールの発信先が応答した時刻
     queueing_ends_at
キューに入っていた着信が切れた時刻、または、通話終了した時刻
       call_type


通話種別
OUTGOING_CALL: 外線発信
OUTGOING_TRANSFER: 外線転送
INCOMING_CALL: 外線着信
QUEUEING_CALL: キューイング着信
EXTENSION: ユーザー宛内線
EXTENSION_GROUP: グループ宛内線
EXTENSION_TRANSFER: ユーザー宛内線転送
EXTENSION_GROUP_TRANSFER: グループ宛内線転送

PREDICTIVE_DIAL: プレディクティブコール
AUTOMATIC_TRANSFER: 自動転送
AUTOMATIC_RECORD: 留守番電話
READ_DTMF: IVR プッシュ番号
INCOMING_CALL_USER: 特定ユーザーへの外線着信

     circuit_number
回線番号
     circuit_name
回線名
    from_number
発信元電話番号
発信の場合は null、発信時は circuit_number を確認
     to_number
発信先電話番号
     previous_id
直前のアクションのシーケンス ID (直前のアクションがない場合は null)
     dtmf
IVR で選択された番号
     minutes
議事録の内容
    participants
発話者
       id
発話者を識別する ID
      from_to

FROM: 発信元
TO: 発信先

      name
発話者名
MiiTel ユーザー名
または、MiiTel 連絡先に登録されている取引先担当者名 (連絡先に登録ない場合は null)
      company_name
取引先会社名
      login_id
MiiTel のログイン ID
追加したペイロードのキー 追加したペイロードの値

ペイロード(リクエストボディー)のサンプル

{
    "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": [
                        [
                            4.66,
                            39.91
                        ],
                        [
                            40.32,
                            44.43
                        ]
                    ],
                    "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": "73578620-476d-4ae1-93c4-ba911ab4a14c",
        "tenant_code": "tyo101-stg",
        "details": [
            {
                "id": "73578620-476d-4ae1-93c4-ba911ab4a14c",
                "dial_starts_at": "2023-11-28T07:26:06+00:00",
                "dial_answered_at": null,
                "dial_ends_at": "2023-11-28T07:26:11+00:00",
                "queueing_starts_at": null,
                "queueing_answered_at": null,
                "queueing_ends_at": null,
                "call_type": "OUTGOING_CALL",
                "circuit_number": "05000000000",
                "circuit_name": "05000000000",
                "from_number": null,
                "to_number": "09000000000",
                "previous_id": null,
                "dtmf": null,
                "analysis": null,
                "participants": [
                    {
                        "id": "018c14d2-2e10-c314-040e-694a1a26d1d6",
                        "from_to": "FROM",
                        "name": "tanaka tarou",
                        "company_name": null,
                        "analysis": null
                    },
                    {
                        "id": "018c14d2-2e10-2446-420b-df78daad7515",
                        "from_to": "TO",
                        "name": null,
                        "company_name": null,
                        "analysis": null
                    }
                ],
                "tags": [],
                "comments": [],
                "keywords": [],
                "phrases": [],
                "speech_recognition": {
                    "raw": "",
                    "summary": ""
                }
            }
        ]
    },
    "ip_restricted": true
}
{
    "call": {
        "id": "60e7d534-6d27-40a4-9d3a-385a648e5b28",
        "tenant_code": "tyo101-stg",
        "details": [
            {
                "id": "60e7d534-6d27-40a4-9d3a-385a648e5b28",
                "dial_starts_at": "2023-11-28T07:26:18+00:00",
                "dial_answered_at": "2023-11-28T07:26:23+00:00",
                "dial_ends_at": "2023-11-28T07:29:34+00:00",
                "queueing_starts_at": null,
                "queueing_answered_at": null,
                "queueing_ends_at": null,
                "call_type": "OUTGOING_CALL",
                "circuit_number": "05000000000",
                "circuit_name": "05000000000",
                "from_number": null,
                "to_number": "09000000000",
                "previous_id": null,
                "minutes": "【議題】\n不明\n\n【重要なポイント】\n- 参加者が3分間待つことに合意したこと\n\n【今後取るべき方針】\n不明",
                "participants": [
                    {
                        "id": "018c14d2-5a39-5312-315a-249e9e94526e",
                        "from_to": "FROM",
                        "name": "tanaka tarou",
                        "company_name": null,
                        "login_id": "[email protected]"
                    },
                    {
                        "id": "018c14d2-5a39-97a5-dcc4-d4f894078335",
                        "from_to": "TO",
                        "name": null,
                        "company_name": null,
                        "login_id": null
                    }
                ]
            }
        ]
    },
    "ip_restricted": true
}

うまくいかない場合

フォーラム からご質問ください!