AutoCall結果取得API

開発中

POST

/cdapi/pluginautocall/{apiVersion}/{sourceUuid}/AutoCallRequest/index

機能

AutoCall要求の結果を取得します

基本的にAutoCallの処理結果ステータスはリアルタイムで取得可能です。

処理結果ステータスが発信済み（100,903）の場合、概ね3分以内に詳細ステータスへ更新されます。

詳細ステータスの取得が必要な場合、一定時間後に本APIを再リクエストして下さい。

APIのリクエストタイミングによっては発信済み（100,903）が返却されず、詳細ステータスが直接返却される場合もあります。

処理結果ステータス

000: 架電止め（架電止めチェックにより発信しなかった）
001: 話中（のため接続できなかった）
002: 応答無し・タイムアウト
100: 発信済み（発信後、呼出が開始されるまで）
900: 未コール（AutoCall実施前）
902: 発信準備中（CT-e1からの発信準備中）
903: 発信済み（呼出中/呼出済）
904: 処理失敗（様々な要因で接続できなかった）　
998: 発信キャンセル（AutoCallキャンセルAPIでキャンセルされた）

詳細ステータス

104: 呼出中切断（発信先を呼出中に切断）
200: 受信切断１（待ち呼中に切断）
201: 受信切断２（エージェント呼出中に切断）
202: 成功　（エージェントとの通話が成功）

エラー

存在しないリクエストパラメータ

リクエストパラメータ不足

許可されていないテナントIDに対するAutoCall要求

7日以上前に発行されたAutoCall要求IDに対する要求

Requestパラメータ

Pathパラメータ

apiVersion

string

必須

APIバージョンを示す文字列

サンプル値:

sourceUuid

string

必須

APIの利用者ごとに発行されるUUID形式の文字列

サンプル値:

d70c9bba-b71f-4021-b68c-0dccb2d99999

Headerパラメータ

Authorization

string

必須

APIキーを設定する APIキーは、事前共有する

サンプル値:

Bearer e0167b81201d415ab0d7ce9081849999

Request Bodyパラメータapplication/json

tenantId

string

テナントID

必須

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

reqId

string

オートコールリクエストID

必須

オートコールリクエストを受け取った際に発行するID

例

{
    "tenantId": "05053699999",
    "reqId": "1234"
}

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/cdapi/pluginautocall/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/AutoCallRequest/index' \
--header 'Authorization: Bearer e0167b81201d415ab0d7ce9081849999' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "05053699999",
    "reqId": "1234"
}'

Response

🟢200成功

application/json

Body

status

string

ステータス

必須

成功：complete 失敗：error

tenantId

string

テナントID

必須

リクエストパラメータで指定されたテナントID

reqId

string

AutoCall要求ID

必須

AutoCall要求で設定されていたID

phoneNumberList

array [object {4}]

必須

phoneNumber

string

発信先電話番号

必須

AutoCallの発信先電話番号
半角数字のみ設定可能

callResult

string

処理結果ステータス

可選

AutoCallの処理結果ステータス・詳細ステータス

sessionId

integer

セッションID

可選

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

calledTime

string

発信日時

可選

AutoCallの発信日時
ISO8601 形式(GMT)

discription

string

説明

可選

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

例

{
    "status": "complete ",
    "tenantId": "05053699999",
    "reqId": "100001",
    "phoneNumberList": [
        {
            "phoneNumber": "99999999901",
            "callResult": "99",
            "sessionId": 942125,
            "calledTime": "2025-02-06T08:45:33.090Z"
        },
        {
            "phoneNumber": "99999999902",
            "callResult": "8",
            "sessionId": 942130,
            "calledTime": "2025-02-06T20:21:35.484Z"
        },
        {
            "phoneNumber": "99999999903",
            "callResult": "0",
            "sessionId": null,
            "calledTime": ""
        }
    ],
    "discription": ""
}

🟢200失敗

更新日時 2025-07-16 01:52:50

AutoCall要求API(即時発信方式)

AutoCall発信完了通知API

AutoCall結果取得API

機能#

処理結果ステータス#

詳細ステータス#

エラー#

Requestパラメータ

サンプルコード

Response

機能

処理結果ステータス

詳細ステータス

エラー