General_API
  1. AutoCall
General_API
  • コムデザインAPIドキュメント
    • 汎用API
      • サービス
      • 汎用API共通仕様
      • 汎用APIを利用開始までの流れ
      • 汎用APIドキュメント
        • 通話ステータス通知API
        • 通話履歴取得API
        • 待呼取得API
        • 音声認識結果一括取得API
        • 音声認識結果取得API
        • 音声認識結果一括送信API
        • 音声データ取得API
        • 使用回線数取得API
    • AutoCall
      • AutoCallAPIドキュメント
      • AutoCall要求API(順次発信方式)
        POST
      • AutoCall要求API(即時発信方式)
        POST
      • AutoCall結果取得API
        POST
      • AutoCall発信完了通知API
        POST
      • AutoCallキャンセルAPI
        POST
      • AutoCall架電止めAPI
        POST
    • WebSocket（リアルタイム連携）
      • 音声データ連携
        • 音声データ連携ドキュメント
        • WebSocket切断方法
        • WebSocket 音声用API
        • WebSocket 制御用API
      • 音声認識結果連携
        • 音声認識結果連携ドキュメント
        • 音声認識メッセージ
        • 音声認識メッセージ形式
    • 変更履歴
  1. AutoCall

AutoCall架電止めAPI

開発中
POST
/general/{apiVersion}/{sourceUuid}/AutoCallRequest/callstop

機能#

指定された発信先電話番号へのAutoCall発信をスキップします

エラー#

存在しないリクエストパラメータ（即時発信方式に対するキャンセル要求を含む）
リクエストパラメータ不足
許可されていないテナントIDに対する要求
すでに完了しているAutoCall要求に対するキャンセル要求

Requestパラメータ

Pathパラメータ
apiVersion
string 
必須
APIバージョンを示す文字列
サンプル値:
v1
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
必須
AutoCall要求で設定されていたID
phoneNumber
string 
発信先電話番号
必須
AutoCallの発信先電話番号
半角数字のみ設定可能
例
{
    "tenantId": "05053699999",
    "reqId": "1234",
    "phoneNumber": "99999999901"
}

サンプルコード

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/general/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/AutoCallRequest/callstop' \
--header 'Authorization: Bearer e0167b81201d415ab0d7ce9081849999' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "05053699999",
    "reqId": "1234",
    "phoneNumber": "99999999901"
}'

Response

🟢200成功
application/json
Body
status
string 
ステータス
必須
成功：complete 失敗：error
tenantId
string 
テナントID
必須
リクエストパラメータで指定されたテナントID
reqId
string 
オートコールリクエストID
必須
オートコールリクエストを受け取った際に発行するID
phoneNumber
string 
発信先電話番号
必須
AutoCallの発信先電話番号
半角数字のみ設定可能
discription
string 
説明
可選
失敗の場合、失敗原因を表す任意のメッセージ
例
{
    "status": "complete",
    "tenantId": "05053699999",
    "reqId": "100001",
    "phoneNumber": "99999999901",
    "discription": ""
}
🟢200失敗
更新日時 2025-07-14 01:30:05
前へ
AutoCallキャンセルAPI
次へ
音声データ連携ドキュメント
Built with