AutoCall要求API(順次発信方式)

開発中

POST

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

機能

AutoCallの発信要求を、 CT-e1に対してリスト形式で要求する場合に利用します。

AutoCallリクエストを受け付け後、所定の条件で順次AutoCall発信を行います

AutoCallは、最初に発信先電話番号へ発信し相手に繋がった場合、オペレータに接続します。

「架電止め利用可否」が指定された場合、「架電止め利用可否」の判定後に空回線チェック、空エージェントチェックを実施します

1回の要求でリクエスト可能なAutoCall数（発信先電話番号）は100件とします。

「着信スキルID」と「IVRフローID」のいずれかは必須となります。

「着信スキルID」を指定してリクエストされたAutoCall要求を処理中、同名の「着信スキルID」を指定したAutoCall要求は受け付けません。

「着信スキルID」を未設定でリクエストされたAutoCall要求を処理中、後続のAutoCall要求を受け付けません。

エラー

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

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

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

許可されていないタイミングでのAutoCall要求

有効な発信先電話番号が0件もしくは100件以上

不正な発信先電話番号が1件以上含まれている

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

string

必須

リクエスト元で発行する管理用ユニークID,最大60文字

tenantId

string

テナントID

必須

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

groupId

string

局番スキルID

必須

CT-e1が発行する局番スキルID

skillId

string

着信スキルID

可選

CT-e1が発行する着信スキルID

ivrFlowID

string

IVRフローID

可選

CT-e1が発行するIVRフローID
IVRフローに従って、受電するエージェントを決定します

unoccupied

integer

残り回線数

可選

指定された残り回線数以上の空があれば、AutoCallの発信を行います
未設定,もしくは無効な値が設定されている場合、回線数に空があればAutoCallの発信を行います

remainingAgents

integer

残りエージェント数

可選

指定された着信スキルIDで受付可ステータスのエージェント数が、
指定された残りエージェント数以上の場合、AutoCallの発信を行います
未設定,もしくは無効な値が設定されている場合、残りエージェント数を考慮せずAutoCallの発信を行います

ringTime

integer

リンギング秒数

可選

AutoCallを発信した後の待ち時間を秒単位で指定します
1～60の整数のみ。
未設定未設定,もしくは無効な値が設定されている場合、30秒とします

useCallStop

integer

架電止め利用可否

可選

AutoCallを発信する前に、AutoCallの依頼元へAPIで発信可否を確認します
0：利用しない　1：利用する
未設定、もしくは無効な値が設定されている場合、利用しないとなります

phoneNumberList

array [object {3}]

必須

phoneNumber

string

発信先電話番号

必須

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

url

string

URL

可選

AutoCallが確立した場合に表示するURL

memo

string

メモ

可選

任意の情報を連携する際に利用します
システム間連携に利用するパラメーターを指定する場合、別途APIのカスタマイズが必要となります

例

{
    "id": "100001",
    "tenantId": "05053699999",
    "groupId": "05034909999@05034909999",
    "skillId": "S03@05034909999",
    "ivrFlowID": "XXXXXX_AUTOIVR_001",
    "unoccupied": 5,
    "remainingAgents": 3,
    "ringTime": 10,
    "useCallStop": 1,
    "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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/cdapi/pluginautocall/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/AutoCallRequest/sequential' \
--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,
    "useCallStop": 1,
    "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

string

ステータス

必須

成功：complete 失敗：error

tenantId

string

テナントID

必須

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

reqId

string

AutoCall要求ID

必須

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

discription

string

説明

可選

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

例

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

🟢200失敗

更新日時 2025-07-14 01:30:05

AutoCallAPIドキュメント

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

AutoCall要求API(順次発信方式)

機能#

エラー#

Requestパラメータ

サンプルコード

Response

機能

エラー