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
/cdapi/pluginautocall/{apiVersion}/{sourceUuid}/AutoCallRequest/Immediate

機能#

AutoCallの発信要求を、 CT-e1に対してリスト形式で要求する場合に利用します。
AutoCallリクエストを受け付けたタイミングで、指定された条件で発信可能な発信先電話番号へ発信します。発信できなかった発信先電話番号に対しては発信しません。
AutoCallは、最初に発信先電話番号へ発信し相手に繋がった場合、オペレータに接続します。
1回の要求でリクエスト可能なAutoCall数(発信先電話番号)は100件とします。
「着信スキルID」と「IVRフローID」のいずれかは必須となります。

エラー#

存在しないリクエストパラメータ
リクエストパラメータ不足
許可されていないテナントIDに対するAutoCall要求
有効な発信先電話番号が0件もしくは100件以上
不正な発信先電話番号が1件以上含まれている

Requestパラメータ

Pathパラメータ

Headerパラメータ

Request Bodyパラメータapplication/json

例
{
    "id": "100001",
    "tenantId": "05053699999",
    "groupId": "05034909999@05034909999",
    "skillId": "S03@05034909999",
    "ivrFlowID": "XXXXXX_AUTOIVR_001",
    "unoccupied": 5,
    "remainingAgents": 3,
    "ringTime": 10,
    "phoneNumberList": [
        {
            "phoneNumber": "99999999901",
            "url": "https://comdesign.co.jp/99999999901",
            "memo": "memo1"
        },
        {
            "phoneNumber": "99999999902",
            "url": "https://comdesign.co.jp/99999999902",
            "memo": "memo2"
        },
        {
            "phoneNumber": "99999999903",
            "url": "https://comdesign.co.jp/99999999903",
            "memo": "memo3"
        }
    ],
    "discription": ""
}

リクエストコードサンプル

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 '/cdapi/pluginautocall/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/AutoCallRequest/Immediate' \
--header 'Authorization: Bearer e0167b81201d415ab0d7ce9081849999' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "100001",
    "tenantId": "05053699999",
    "groupId": "05034909999@05034909999",
    "skillId": "S03@05034909999",
    "ivrFlowID": "XXXXXX_AUTOIVR_001",
    "unoccupied": 5,
    "remainingAgents": 3,
    "ringTime": 10,
    "phoneNumberList": [
        {
            "phoneNumber": "99999999901",
            "url": "https://comdesign.co.jp/99999999901",
            "memo": "memo1"
        },
        {
            "phoneNumber": "99999999902",
            "url": "https://comdesign.co.jp/99999999902",
            "memo": "memo2"
        },
        {
            "phoneNumber": "99999999903",
            "url": "https://comdesign.co.jp/99999999903",
            "memo": "memo3"
        }
    ],
    "discription": ""
}'

Response

🟢200成功
application/json
Body

例
{
    "status": "complete",
    "tenantId": "05053699999",
    "reqId": "100001",
    "phoneNumberList": [
        {
            "phoneNumber": "99999999901"
        },
        {
            "phoneNumber": "99999999902"
        },
        {
            "phoneNumber": "99999999903"
        }
    ],
    "discription": ""
}
🟢200失敗
更新日時 2025-07-14 01:30:05
前へ
AutoCall要求API(順次発信方式)
次へ
AutoCall結果取得API
Built with