VoiceNotify API

アウトバウンドのAI音声通話を自動発信し、
可視化・レポーティング・ワークフロー自動化に活用できる構造化された通話結果を取得できます。

エンドポイント

POST
https://api-v1.delight.fit/voicenotify

ヘッダー

Content-Type: application/x-www-form-urlencoded

リクエストデータの送信形式を指定します。

リクエスト例

curl --location 'https://api-v1.delight.fit/voicenotify'
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'access_token=YOUR_ACCESS_TOKEN'
--data-urlencode 'rows=[{...}]'

リクエスト項目の説明

access_token
API認証キーです。リクエストが正当なものであることを確認します。
外部に漏れないよう厳重に管理してください。

rows
発信する通話データの配列です。
1回のリクエストで複数の通話を送信できます。

message
AIが通話中に読み上げる音声メッセージ内容です。

caller
発信者として表示される電話番号（発信者番号通知）。

phone
発信先の電話番号（通話相手）。

language
通話で使用する言語（例："en" = 英語、"ja" = 日本語）。

UTC
処理やスケジュール管理に使用するタイムゾーン情報。

callback_token
CRMやキャンペーンIDなど、自社システムと通話結果を紐づけるための任意の識別子。

callback_url
通話完了後に結果データが送信されるURL。

APIレスポンス例

{
"success": "1",
"result": {
"count": "2",
"success_count": "2",
"errors_count": "0"
}
}

レスポンス項目

success
リクエストが受理されたかどうか（1 = 成功）。

count
送信された通話総数。

success_count
正常に処理された通話数。

errors_count
失敗した通話数。

コールバックレスポンス例

{
"callee": "8190390456xx",
"caller": "8150505008xx",
"call_result_code": "200"
}

call_result_code は、その通話で何が起きたかを示します。

通話結果コード（Call Result Codes）

以下は call_result_code の一覧とその意味です。

200 – 通話成功（応答あり）

キャンペーン種別：自動 / エージェント
発信先が通話に応答しました。

1 – 留守番電話検出

キャンペーン種別：自動 / エージェント
通話は留守番電話に接続されました。
エージェントキャンペーンでは、設定で留守番電話検出が有効になっている場合のみ、この判定になります。

2 – 相手側が通話終了

キャンペーン種別：自動 / エージェント
相手が通話を切断しました。
エージェントキャンペーンでは、キュー待ち中に切断された場合も含みます。

3 – シナリオ終了

キャンペーン種別：自動
自動音声シナリオが事前定義されたフロー通りに正常終了しました。

486 – 通話中（ビジー）

キャンペーン種別：自動 / エージェント
相手が別の通話中でした。

408 / 487 / 500 – 応答なし

キャンペーン種別：自動 / エージェント
電話に応答がありませんでした（電源OFFなど）。

603 – 着信拒否

キャンペーン種別：自動 / エージェント
相手が通話を拒否しました。

404 – 無効な番号

キャンペーン種別：自動 / エージェント
発信先の電話番号が誤っている、または存在しません。

480 – 利用不可

キャンペーン種別：自動 / エージェント
電源OFF、または圏外などで接続できませんでした。

403 – 発信不可

キャンペーン種別：自動 / エージェント
DNC（Do Not Call）リストなどにより発信が許可されていません。

0 – 発信未実行

キャンペーン種別：自動 / エージェント
相手に到達する前に通話が中断されました。

4 – テスト中に停止

キャンペーン種別：自動
シナリオテスト中に「Stop」ボタンで中断されました。
通話履歴には表示されません。

5 – エージェント接続失敗

キャンペーン種別：エージェント
利用可能なエージェントに接続できませんでした。

610 – 通信事業者エラー

キャンペーン種別：自動 / エージェント
通信キャリア側の問題により接続できませんでした。

通話結果データの活用方法

これらの結果コードを活用することで：

・ビジーや未応答の自動再発信
・CRMのリードステータス自動更新
・接続率・コンタクト率の測定
・無効番号の特定とデータクレンジング
・キャンペーンパフォーマンスの可視化

が可能になります。