通話ステータス通知API

開発中

POST

/mup/call_status

General

機能

記載しているエンドポイントはサンプルです。エンドポイントの決定後、ご連絡ください

通話ステータスが変更されたタイミングを通知するAPIです

通知先で本通知を受け取るためのAPIを作成する必要があります

通話開始、保留等の通話ステータスは、全エージェントに対して通知します

音声認識完了は、音声認識対象となった通話のみ通知します

レスポンスは不要です

本APIは、おおよその目安となる通話ステータスを通知するものです。このため、厳密な通話ステータスの管理には利用できません

Requestパラメータ

Headerパラメータ

Authorization

string

必須

Bearer e0167b81201d415ab0d7ce9081849999 形式のAPIキーを設定する
APIキーは、事前共有する

Request Bodyパラメータapplication/json

tenantId

string

テナントID

必須

CT-e1が発行するテナントID。テナントを一意に特定する

sessionId

integer

セッションID

必須

CTe-1で生成されるテナント単位で通話を識別するID。転送時も変化しない。複数テナントの情報を扱う場合、重複することがある。

recordId

integer

レコードID

必須

通話内で保留、転送等で通話が分かれた場合に発番されるID

通話内で１からシーケンシャルに付与される

status

integer

通話ステータス

必須

1:通話開始
2:保留
3:保留解除
4:転送
5:転送再開（転送後、カスタマーとの会話が再開されたタイミング）
6:通話終了
8:音声認識完了（通話内の全ての音声認識処理が完了したタイミング）

discription

string

説明

可選

失敗の場合、失敗原因を表す任意のメッセージ

例

{
	"tenantId": "05053698341",
	"sessionId": 942125,
	"recordId": 1,
	"status": 8,
	"description": ""
}

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/mup/call_status' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"tenantId": "05053698341",
	"sessionId": 942125,
	"recordId": 1,
	"status": 8,
	"description": ""
}'

Response

🟢200成功

application/json

Body

object {0}

例

{}

汎用APIを利用開始までの流れ

通話履歴取得API

通話ステータス通知API

機能#

Requestパラメータ

サンプルコード

Response

機能