AutoCallキャンセルAPI

機能

順次発信方式のAutoCall要求をキャンセルします

発信が開始されているAutoCallはキャンセルされません。リクエスト以降のAutoCallの発信がキャンセルされます

エラー

存在しないリクエストパラメータ（即時発信方式に対するキャンセル要求を含む）

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

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

すでに完了しているAutoCall要求に対するキャンセル要求

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

Response

🟢200成功

application/json

Body

status

string

ステータス

必須

成功：complete 失敗：error

tenantId

string

テナントID

必須

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

reqId

string

AutoCall要求ID

必須

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

discription

string

説明

可選

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

例

{
    "status": "complete",
    "tenantId": "05053699999",
    "reqId": "100001",
    "discription": ""
}

🟢200失敗

AutoCallキャンセルAPI

機能#

エラー#

Requestパラメータ

サンプルコード

Response

機能

エラー