共通認証

リクエストURL

https://ccps.s4.udesk.cn/api/v1/ads/external/{relative address}?{URL params}&Email={email}&AppId={appId}&Timestamp={timestamp}&Token={token}

括弧内の各部分の意味は以下の通りです:

変数 説明
relative address: インターフェース相対アドレス APIの相対URL
URL params: URLパラメータ リクエストインターフェースに必要なパラメータ
email: ユーザーメールアドレス ユーザーのメールアドレス
appId: テナントappId テナントappId; 取得方法: システム管理->システム設定->システム情報
secret: テナントsecret テナントsecret; 取得方法: システム管理->システム設定->システム情報
timestamp: タイムスタンプ リクエストを開始した時点のタイムスタンプ、'1970-01-01 00:00:00'から現在までの秒数。特に指定がない限り、デフォルトの有効期限は5分です
token: 署名 認証署名。特に指定がない限り、すべてのAPIリクエストにこのパラメータを付加する必要があります。詳細な生成アルゴリズムについては鉴权方法を参照してください

認証方法

appId:18a58d6d-2b4e-44de-5725-31b9e5dbb4b4
secret:secret-37a4123c-538f-4b91-69c1-3fd15500c9b2
timestamp:1496631984

HmacUtils hmacUtils = new HmacUtils(HmacAlgorithms.HMAC_SHA_1, "secret-37a4123c-538f-4b91-69c1-3fd15500c9b2");
hmacUtils.hmacHex("18a58d6d-2b4e-44de-5725-31b9e5dbb4b4"+"1496631984")
 -> 6d9faaab002f49b2a9b8c634279a7e29414ea1cb

リクエストURL:

https://ccps.s4.udesk.cn/api/v1/ads/external/callTasks?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb

インターフェース説明

連絡先インポートの説明:

  1. 連絡先リストと対応するインポート番号を使用する場合、発信タスクを編集して番号をタスクに関連付けます

  2. デフォルトの連絡先リストと対応するインポート番号を使用する場合、対応するタスクに直接インポートします

オンラインドメインの説明:

  1. ドキュメント内のサンプルのドメインは demo.udesk.cn ですが、実際の接続時には、開設されたテナントの地域に応じて異なるドメインを使用する必要があります。具体的なドメインについては、テナント開設担当者にお問い合わせください

発信タスク作成インターフェース

リクエストURL

リクエストパラメータ

パラメータ タイプ Null可 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例: 現在の秒数、1533092860)
Token String false 署名: 認証署名(共通認証説明を参照)
name String false タスク名
remark String true 説明
callTemplateId int false 発信テンプレート
robotDefId int false 発信ロボット定義id
spnumberType int false 発信元番号タイプ(1中継番号2番号プール)
spnumberValue int false 発信元番号値
startMode int false 起動方式(1手動2スケジュール3周期起動)
startTime date true 起動時間(スケジュール使用時 yyyy-MM-dd HH:mm:ss)
workTimeId int false 勤務時間
priority int false タスク優先度
controlOptionList Array true タスクオプション(列挙型整数配列, 1連絡先なし自動停止)
ivrMode int true IVRモード(0オフ1オン)
callType int true 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密ivr 7:純粋ivr 8:AI予測式発信)
concurrentLimit int false タスク同時実行数
dialParam Object true 発信設定パラメータ
dialParam.optimizeParam int true 最適化パラメータ(1エージェント利用率2放棄通話率3エージェント平均待機時間)
dialParam.optimizeTarget int true 最適化目標
callPriorityMode int true 通話優先モード、0-再発信優先、1-初回発信優先
redialSceneList Array true 再試行オプション
redialSceneList[].type int false 通話結果タイプ(1通話失敗 2通話無効 3タグ)
redialSceneList[].result String true 通話結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,発信方法不正,着信制限,転送失敗,ネットワークビジー,応答なし,料金未払い,通話不可,番号変更,回線障害,後でかけ直し,その他)
redialSceneList[].dealOption int false 処理方法(1再発信)
redialSceneList[].redialTimes int true 再試行回数
redialSceneList[].redialGuide int true 時間間隔(分)
redialSceneList[].guideIncrement int true 間隔増分(分)
redialSceneList[].nextDeal int true 後続処理(1連絡先次回電話)
taskContactBatchRelList Array true 連絡先リスト
taskContactBatchRelList[].contactBatchId int true 連絡先リストid
taskContactBatchRelList[].callWeight int true 発信重み付け
### レスポンスパラメータ
パラメータ タイプ 空値可 説明
--- --- --- ---
succeed boolean false 処理識別子(現在未使用)
code String false リターンコード
bizCode String false ビジネスコード(現在未使用)
message String false リターンメッセージ
visible boolean false 可視性(現在未使用)
data Object true 結果
data.id int false タスクID
data.name String false タスク名
data.remark String true 説明
data.callTemplateId int false 発信テンプレート
data.robotDefId int false 発信ロボット定義ID
data.ivrId int true IVR ID
data.queueId int true キュー値
data.spnumberType int false 発信元番号タイプ(1:中継番号 2:番号プール)
data.spnumberValue int false 発信元番号値
data.startMode int false 起動方式(1:手動 2:スケジュール 3:周期起動)
data.startTime date true 起動時間(スケジュール使用 yyyy-MM-dd HH:mm:ss)
data.expireTime date true タスク有効期限
data.validDuration int true 通話有効性時間閾値
data.workTimeId int false 勤務時間
data.priority int false タスク優先度
data.controlOption String false タスク優先度
data.controlOptionList Array true タスクオプション(列挙整数配列, 1:連絡先なしで自動停止)
data.resetOption int true リセットオプション
data.status int true タスクステータス
data.totalCount int true 顧客数
data.execCount int true 実行済み顧客数
data.customerConnectCount int true 顧客応答数
data.agentConnectCount int true オペレーター応答数
data.retryCount int true 試行回数
data.numberFilter int true 番号フィルター
data.numberFilterList Array true 現在未使用
data.ivrMode int false IVRモード(0:オフ 1:オン)
data.callType int false 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測型発信)
data.concurrentLimit int false タスク同時実行数
data.createdUserId String true 作成者ID
data.updatedUserId String true 最終更新者ID
data.createdAt String true 作成日時
data.contactBatchIds String true 連絡先ID群
data.contactBatchIdList Array true 現在未使用
data.taskContactBatchRelList Array true 連絡先情報
data.taskContactBatchRelList[].callTaskId int true 発信タスクID
data.taskContactBatchRelList[].contactBatchId int true 連絡先リストID
data.taskContactBatchRelList[].contactBatchName String true 連絡先リスト名
data.taskContactBatchRelList[].callWeight int true 重み
data.taskContactBatchRelList[].status int true ステータス
data.taskContactBatchRelList[].importStatus int true インポートステータス(1:待機 2:インポート中 3:インポート済み)
data.taskContactBatchRelList[].totalCount int true 顧客数
data.taskContactBatchRelList[].execCount int true 実行済み顧客数
data.taskContactBatchRelList[].customerConnectCount int true 顧客応答数
data.taskContactBatchRelList[].agentConnectCount int true オペレーター応答数
data.taskContactBatchRelList[].retryCount int true 試行回数
data.taskContactBatchRelList[].createdUserId String true 作成者ID
data.taskContactBatchRelList[].updatedUserId String true 最終更新者ID
data.taskContactBatchRelList[].deleteFlag int true 削除フラグ(0:未削除 1:削除済み)
data.redialSceneJson String true 再発信オプション
data.callTemplate Objcet true 発信テンプレート
data.callTemplate.name String true 名称
data.callTemplate.remark String true 備考
data.callTemplate.numberFilter String true 番号フィルター
data.callTemplate.numberFilterList Array true 現在未使用
data.callTemplate.ivrMode int true IVRモード：0:オフ 1:オン
data.callTemplate.callType int true 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測型発信)
data.callTemplate.dialParamJson String true 現在未使用
data.callTemplate.dialParam Object true 現在未使用
data.callTemplate.dialParam.optimizeParam int true 現在未使用
data.callTemplate.dialParam.optimizeTarget int true 現在未使用
data.callTemplate.dialParam.callInDurationAverage int true 現在未使用
data.callTemplate.dialParam.callOutDurationAverage int true 現在未使用
data.callTemplate.dialParam.callInPerHour int true 現在未使用
data.callTemplate.dialParam.callPerMinute int true 現在未使用
data.callTemplate.dialParam.longDurationIgnore int true 現在未使用
data.callTemplate.concurrentLimit int true タスク同時実行数
data.callTemplate.createdUserId String true 最終更新者ID
data.callTemplate.updatedUserId String true 作成者ID
data.callTemplate.deleteFlag int true 削除フラグ(0:未削除 1:削除済み)
data.callTemplate.redialSceneJson String true 再発信オプション
data.callTemplate.category int true カテゴリ(1:自動発信 2:AI)
data.callTemplate.ivrId int true IVR ID
data.callTemplate.queueId int true キューID
data.callTemplate.spnumberType int true 発信元番号タイプ
data.callTemplate.spnumberValue int true 発信元番号値
data.callTemplate.startMode int true 発信元番号値
data.callTemplate.startTime date true 起動時間
data.callTemplate.expireTime date true タスク有効期限
data.callTemplate.workTimeId int true 勤務時間
data.callTemplate.validDuration int true 通話有効性時間閾値
data.callTemplate.maxRingSeconds int true 最大呼出音時間閾値
data.callTemplate.robotDefId int true 現在未使用
data.momentLimit int true 現在未使用
data.operatorCreateName String true 操作作成者
data.category int true カテゴリ(1:自動発信 2:AI)
data.dialParam Object true 発信設定パラメータ
data.dialParam.optimizeParam int true 最適化パラメータ(1:オペレーター利用率 2:放棄通話率 3:オペレーター平均待機時間)
data.dialParam.optimizeTarget int true 最適化目標
data.redialSceneList Array true 再試行オプション
data.redialSceneList[].type int true 通話結果タイプ(1:通話無効 2:通話失敗 3:タグ)
data.redialSceneList[].result String true 通話結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,発信方式不正,着信制限,転送失敗,ネットワークビジー,応答なし,料金未払い,通話不可,番号変更,回線障害,後でかけ直し,その他)
data.redialSceneList[].valid int true 有効性(デフォルトは無効-2)
data.redialSceneList[].labelInfos Array true タグ
data.redialSceneList[].dealOption int false 処理方法(1:再発信)
data.redialSceneList[].redialTimes int true 再試行回数
data.redialSceneList[].redialGuide int true 時間間隔(分)
data.redialSceneList[].guideIncrement int true 間隔増分(分)
data.redialSceneList[].nextDeal int true 後続処理(1:連絡先の次の電話)
data.taskContactBatchRelList Array true 連絡先リスト
data.taskContactBatchRelList[].contactBatchId int true 連絡先リストID
data.taskContactBatchRelList[].callWeight int true 発信重み
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/ai?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{

    "name":"テスト発信1",
    "remark":"テスト発信",
    "callTemplateId":5,
    "robotDefId":300001,
    "spnumberType":1,
    "spnumberValue":72,
    "startMode":1,
    "startTime":null,
    "workTimeId":31,
    "priority":1,
    "controlOptionList":[
        1
    ],
    "ivrMode":1,
    "callType":0,
    "concurrentLimit":1,
    "dialParam":{
        "optimizeParam":1,
        "optimizeTarget":1
    },
    "redialSceneList":[
        {
            "result":"ユーザー拒否",
            "dealOption":1,
            "redialTimes":1,
            "redialGuide":1,
            "guideIncrement":1,
            "nextDeal":1
        }
    ],
    "taskContactBatchRelList":[
        {
            "callWeight":100,
            "contactBatchId":3
        }
    ]
  }'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        "id":80,
        "name":"テスト発信1",
        "remark":"テスト発信",
        "callTemplateId":5,
        "robotDefId":300001,
        "spnumberType":1,
        "spnumberValue":72,
        "startMode":1,
        "startTime":null,
        "workTimeId":31,
        "priority":1,
        "controlOption":"1",
        "controlOptionList":[
            1
        ],
        "status":1,
        "ivrMode":1,
        "callType":0,
        "dialParam":{
            "optimizeParam":1,
            "optimizeTarget":1
        },
        "concurrentLimit":1,
        "taskContactBatchRelList":[
            {
                "contactBatchId":3,
                "callWeight":100
            }
        ],
        "redialSceneList":[
            {
                "result":"ユーザー拒否",
                "dealOption":1,
                "redialTimes":1,
                "redialGuide":1,
                "guideIncrement":1,
                "nextDeal":1
            }
        ]
    }
}

外呼タスク編集インターフェース

リクエストアドレス

リクエストパラメータ

パラメータ タイプ Null可 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例:現在の秒数，1533092860)
Token String false 署名:認証署名(共通認証説明を参照)
id int false タスクID
name String true タスク名
remark String true 説明
spnumberType int false 発信者番号タイプ(1:中継番号 2:番号プール)
spnumberValue int true 発信者番号値
callType int false 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測式発信)
workTimeId int true 勤務時間
priority int true タスク優先度
controlOptionList Array true タスクオプション(列挙整数配列,1:連絡先なしで自動停止)
concurrentLimit int true タスク同時実行数
taskContactBatchRelList Array true 連絡先リスト
taskContactBatchRelList[].contactBatchId int true 連絡先リストID
taskContactBatchRelList[].callWeight int true 発信重み付け

レスポンスパラメータ

パラメータ タイプ Null可 説明
succeed boolean false 処理識別子(現在未使用)
code String false 返却コード
bizCode String false ビジネスコード(現在未使用)
message String false 返却メッセージ
visible boolean false 可視性(現在未使用)
data Object true 結果
data.id int false タスクID
data.name String false タスク名
data.remark String true 説明
data.callTemplateId int false 発信テンプレート
data.robotDefId int false 発信ロボット定義ID
data.ivrId int true IVR ID
data.queueId int true キュー値
data.spnumberType int false 発信者番号タイプ(1:中継番号 2:番号プール)
data.spnumberValue int false 発信者番号値
data.startMode int false 起動方式(1:手動 2:タイマー 3:周期起動)
data.startTime date true 起動時間(タイマー使用時 yyyy-MM-dd HH:mm:ss)
data.expireTime date true タスク有効期限
data.validDuration int true 通話有効性時間閾値
data.workTimeId int false 勤務時間
data.priority int false タスク優先度
data.controlOption String false タスク優先度
data.controlOptionList Array true タスクオプション(列挙整数配列,1:連絡先なしで自動停止)
data.resetOption int true リセットオプション
data.status int true タスク状態
data.totalCount int true 顧客数
data.execCount int true 実行済み顧客数
data.customerConnectCount int true 顧客応答
data.agentConnectCount int true オペレーター応答
data.retryCount int true 試行回数
data.numberFilter int true 番号フィルター
data.numberFilterList Array true 現在未使用
data.ivrMode int false IVRモード(0:オフ 1:オン)
data.callType int false 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測式発信)
data.concurrentLimit int false タスク同時実行数
data.createdUserId String true 作成者ID
data.updatedUserId String true 最終更新者ID
data.createdAt String true 作成時間
data.contactBatchIds String true 連絡先ID一覧
data.contactBatchIdList Array true 現在未使用
data.taskContactBatchRelList Array true 連絡先情報
data.taskContactBatchRelList[].callTaskId int true 発信タスクID
data.taskContactBatchRelList[].contactBatchId int true 連絡先リストID
data.taskContactBatchRelList[].contactBatchName String true 連絡先リスト名
data.taskContactBatchRelList[].callWeight int true 重み付け
data.taskContactBatchRelList[].status int true 状態
data.taskContactBatchRelList[].importStatus int true インポート状態(1:待機 2:インポート中 3:インポート済み)
data.taskContactBatchRelList[].totalCount int true 顧客数
data.taskContactBatchRelList[].execCount int true 実行済み顧客数
data.taskContactBatchRelList[].customerConnectCount int true 顧客応答
data.taskContactBatchRelList[].agentConnectCount int true オペレーター応答
data.taskContactBatchRelList[].retryCount int true 試行回数
data.taskContactBatchRelList[].createdUserId String true 作成者ID
data.taskContactBatchRelList[].updatedUserId String true 最終更新者ID
data.taskContactBatchRelList[].deleteFlag int true 削除フラグ(0:未削除 1:削除済み)
data.redialSceneJson String true 再発信オプション
data.callTemplate Objcet true 発信テンプレート
data.callTemplate.name String true 名称
data.callTemplate.remark String true 備考
data.callTemplate.numberFilter String true 番号フィルター
data.callTemplate.numberFilterList Array true 現在未使用
data.callTemplate.ivrMode int true IVRモード：0:オフ 1:オン
data.callTemplate.callType int true 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測式発信)
data.callTemplate.dialParamJson String true 現在未使用
data.callTemplate.dialParam Object true 現在未使用
data.callTemplate.dialParam.optimizeParam int true 現在未使用
data.callTemplate.dialParam.optimizeTarget int true 現在未使用
data.callTemplate.dialParam.callInDurationAverage int true 現在未使用
data.callTemplate.dialParam.callOutDurationAverage int true 現在未使用
data.callTemplate.dialParam.callInPerHour int true 現在未使用
data.callTemplate.dialParam.callPerMinute int true 現在未使用
data.callTemplate.dialParam.longDurationIgnore int true 現在未使用
data.callTemplate.concurrentLimit int true タスク同時実行数
data.callTemplate.createdUserId String true 最終更新者ID
data.callTemplate.updatedUserId String true 作成者ID
data.callTemplate.deleteFlag int true 削除フラグ(0:未削除 1:削除済み)
data.callTemplate.redialSceneJson String true 再発信オプション
data.callTemplate.category int true カテゴリ(1:自動発信 2:AI)
data.callTemplate.ivrId int true IVR ID
data.callTemplate.queueId int true キューID
data.callTemplate.spnumberType int true 発信者番号タイプ
data.callTemplate.spnumberValue int true 発信者番号値
data.callTemplate.startMode int true 発信者番号値
data.callTemplate.startTime date true 起動時間
data.callTemplate.expireTime date true タスク有効期限
data.callTemplate.workTimeId int true 勤務時間
data.callTemplate.validDuration int true 通話有効性時間閾値
data.callTemplate.maxRingSeconds int true 最大呼出音時間閾値
data.callTemplate.robotDefId int true 現在未使用
data.momentLimit int true 現在未使用
data.operatorCreateName String true 操作作成者
data.category int true カテゴリ(1:自動発信 2:AI)
data.dialParam Object true 発信設定パラメータ
data.dialParam.optimizeParam int true 最適化パラメータ(1:オペレーター利用率 2:放棄通話率 3:オペレーター平均待機時間)
data.dialParam.optimizeTarget int true 最適化目標
data.redialSceneList Array true 再試行オプション
data.redialSceneList[].type int true 発信結果タイプ(1:発信無効 2:発信失敗 3:タグ)
data.redialSceneList[].result String true 発信結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,発信方式不正,着信制限,転送失敗,ネットワークビジー,応答なし,料金未払い,受信不可,番号変更,回線障害,後でかけ直し,その他)
data.redialSceneList[].dealOption int false 処理方法(1:再発信)
data.redialSceneList[].redialTimes int true 再試行回数
data.redialSceneList[].redialGuide int true 時間間隔(分)
data.redialSceneList[].guideIncrement int true 間隔増分(分)
data.redialSceneList[].nextDeal int true 後続処理(1:連絡先の次の電話)
data.taskContactBatchRelList Array true 連絡先リスト
data.taskContactBatchRelList[].contactBatchId int true 連絡先リストID
data.taskContactBatchRelList[].callWeight int true 発信重み付け
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/80?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X PUT -H 'Content-Type: application/json' -d '{

    "name":"テスト発信1",
    "remark":"テスト発信", // 指定されたcallIdの詳細を取得
    "spnumberType":1,
    "spnumberValue":72,
    "workTimeId":31,
    "priority":1,
    "controlOptionList":[
        1
    ],
    "concurrentLimit":1,
    "taskContactBatchRelList":[
        {
            "callWeight":100,
            "contactBatchId":3
        }
    ]
  }'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        "id":80,
        "name":"テスト発信1",
        "remark":"テスト発信",
        "callTemplateId":5,
        "robotDefId":300001,
        "spnumberType":1,
        "spnumberValue":72,
        "startMode":1,
        "startTime":null,
        "workTimeId":31,
        "priority":1,
        "controlOption":"1",
        "controlOptionList":[
            1
        ],
        "status":1,
        "ivrMode":1,
        "callType":0,
        "dialParam":{
            "optimizeParam":1,
            "optimizeTarget":1
        },
        "concurrentLimit":1,
        "taskContactBatchRelList":[
            {
                "contactBatchId":3,
                "callWeight":100
            }
        ],
        "redialSceneList":[
            {
                "result":"ユーザー拒否",
                "dealOption":1,
                "redialTimes":1,
                "redialGuide":1,
                "guideIncrement":1,
                "nextDeal":1
            }
        ]
    }
}

発信タスク開始インターフェース

リクエストアドレス

リクエストパラメータ

パラメータ タイプ 空値可否 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例:現在の秒数、1533092860)
Token String false 署名:認証署名(共通認証説明を参照)
id int false タスクID

レスポンスパラメータ

パラメータ タイプ 空値可否 説明
succeed boolean false 処理識別子(現在未使用)
code String false 返却コード
bizCode String false 業務コード(現在未使用)
message String false 返却メッセージ
visible boolean false 表示可否(現在未使用)

リクエスト例

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/executing?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X PUT -H 'Content-Type: application/json'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false
}

発信タスク一時停止インターフェース

リクエストアドレス

リクエストパラメータ

パラメータ タイプ 空値可否 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例:現在の秒数、1533092860)
Token String false 署名:認証署名(共通認証説明を参照)
id int false タスクID

レスポンスパラメータ

パラメータ タイプ 空値可否 説明
succeed boolean false 処理識別子(現在未使用)
code String false 返却コード
bizCode String false 業務コード(現在未使用)
message String false 返却メッセージ
visible boolean false 表示可否(現在未使用)

リクエスト例

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/pause?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X PUT -H 'Content-Type: application/json'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false
}

アウトバウンドタスク停止インターフェース

リクエストURL

リクエストパラメータ

パラメータ タイプ 空値可否 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例: 現在の秒数、1533092860)
Token String false 署名: 認証署名(共通認証説明を参照)
id int false タスクID

レスポンスパラメータ

パラメータ タイプ 空値可否 説明
succeed boolean false 処理識別子(現在未使用)
code String false リターンコード
bizCode String false 業務コード(現在未使用)
message String false リターンメッセージ
visible boolean false 表示可否(現在未使用)

リクエスト例

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/stop?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X PUT -H 'Content-Type: application/json'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false
}

応答パラメータ

パラメータ タイプ 空値可否 説明
succeed boolean false 処理識別子(現在は使用しない)
code String false 返却コード
bizCode String false 業務コード(現在は使用しない)
message String false 返却メッセージ
visible boolean false 可視性(現在は使用しない)
data Object true 結果
data.id int false 連絡先リストID
data.name String false 連絡先リスト名
data.remark String true 備考
data.focus String true タグ
data.status int false ステータス(1:待機 2:インポート中 3:完了)

リクエスト例

$ curl 'https://demo.udesk.cn/api/v1/ads/external/contactBatchs?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{

    "name":"テストダイヤル1",
    "remark":"テストダイヤル",
    "focus":"タグ"
  }'

応答例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        "id":80,
        "name":"テストダイヤル1",
        "remark":"テストダイヤル",
        "focus":"タグ",
        "status":3
    }
}

-->

AIデフォルト連絡先リスト作成インターフェース

リクエストURL

リクエストパラメータ

パラメータ タイプ 空値可否 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例:現在の秒数、1533092860)
Token String false 署名:認証署名(共通認証説明を参照)
callTaskId int false アウトバウンドタスクID
name String false 連絡先リスト名
remark String true 備考
focus String true タグ

応答パラメータ

パラメータ タイプ 空値可否 説明
succeed boolean false 処理識別子(現在は使用しない)
code String false 返却コード
bizCode String false 業務コード(現在は使用しない)
message String false 返却メッセージ
visible boolean false 可視性(現在は使用しない)
data Object true 結果
data.id int false 連絡先リストID
data.callTaskId int false アウトバウンドタスクID
data.name String false 連絡先リスト名
data.remark String true 備考
data.focus String true タグ
data.status int false ステータス(1:待機 2:インポート中 3:完了)
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/external/contactBatchs/defaultContact?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{

    "callTaskId":1,
    "name":"テスト通話1",
    "remark":"テスト通話",
    "focus":"タグ"
  }'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        "id":80,
        "callTaskId":1,
        "name":"テスト通話1",
        "remark":"テスト通話",
        "focus":"タグ",
        "status":3
    }
}

連絡先番号インポートインターフェース(1回あたり上限50件)

リクエストURL

リクエストパラメータ

パラメータ タイプ Null可 説明
Email String true メールアドレス
AppId String false テナントappId
Timestamp Long false タイムスタンプ(例:現在の秒数、1533092860)
Token String false 署名:認証署名(共通認証説明を参照)
contactBatchId int false 連絡先リストID
dealType int true 重複処理タイプ(1:重複チェックなし 2:現在のタスク)
startTaskFlag int true インポート完了後に発信タスクを開始するか 1: 開始 0:開始しない
encryptionFlag int false 暗号化するか(1-はい 0-いいえ)
algorithmType int true 暗号化タイプ(1 aes 2 des)
secretKey String true 暗号化キー
encryptionRange Array true 暗号化フィールド(["name","mobile"])
numberList Array false 番号リスト
numberList[].name String true 連絡先名
numberList[].mobile String false 携帯電話番号、電話番号（固定電話形式：02186391234、つまり市外局番+固定電話番号、市外局番と固定電話番号を区切る特殊文字は不要。携帯電話番号形式：18812345678）
numberList[].companyName String true 会社
numberList[].remark String true 備考
numberList[].variates Array true カスタム変数(形式:[{"key":"weather","type":"string","value":"北京"}])
### レスポンスパラメータ
パラメータ タイプ 空値可否 説明
--- --- --- ---
succeed boolean false 処理識別子(現在は使用しない)
code String false リターンコード
bizCode String false 業務コード(現在は使用しない)
message String false リターンメッセージ
visible boolean false 可視性(現在は使用しない)
data Object true 結果
data.contactBatchId int false 連絡先リストID
data.successCount int false インポート成功した番号数
data.failedCount int false インポート失敗した番号数
data.dealType int false 重複処理タイプ
data.failedNumberList Array true インポート失敗した番号の配列
data.encryptionFlag int false 暗号化フラグ
data.algorithmType int true 暗号化タイプ
data.secretKey String true 暗号化キー
data.encryptionRange Array true 暗号化フィールド
data.failedNumberList[].name String true 氏名
data.failedNumberList[].mobile String true 電話番号
data.failedNumberList[].companyName String true 会社名
data.failedNumberList[].remark String true 備考
data.failedNumberList[].variates Array true カスタム変数(フォーマット:[{"key":"天気","type":"string","value":"北京"}])
data.failedNumberList[].failedReason String true 失敗理由

リクエスト例

$ curl 'https://demo.udesk.cn/api/v1/ads/external/contactBatchs/syncNumber?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{

    "contactBatchId":1,
    "dealType": 1,
    "encryptionFlag": 1,
    "algorithmType": 1,
    "secretKey": "MTIzNDU2",
    "encryptionRange": ["name,mobile"],
    "numberList":[
        {
            "name":"テスト1",
            "mobile":"13900000000",
            "companyName":"テスト会社1",
            "remark":"備考1",
            "variates":[{"key":"天気","type":"string","value":"北京"}]
        },
        {
            "name":"テスト2",
            "mobile":"1390000001",
            "companyName":"テスト会社2",
            "remark":"備考2",
            "variates":[{"key":"天気","type":"string","value":"北京"}]
        }
    ]
  }'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        "contactBatchId":1,
        "successCount":1,
        "failedCount":1,
        "failedNumberList":[
           {
               "name":"テスト2",
               "mobile":"1390000001",
               "companyName":"テスト会社2",
               "remark":"備考2",
               "variates":[{"key":"天気","type":"string","value":"北京"}]
               "failedReason":"番号が無効です"
           }
       ]
    }
}

アウトバウンドタスク作成インターフェース（簡易版）

リクエストURL

リクエストパラメータ

パラメータ タイプ 必須 説明
name String false タスク名
callTemplateId int false タスクテンプレートID
priority int false タスク優先度
startMode int false 起動方式
(1：手動起動、2：スケジュール起動、3：周期起動)
startTime String true 起動時間（スケジュール起動時必須)
フォーマット："yyyy-MM-dd HH:mm:ss"
startDate String true 起動日(周期起動時必須)
フォーマット："yyyy-MM-dd HH:mm:ss"
endDate String true 終了日(周期起動時必須)
フォーマット："yyyy-MM-dd"
startTimePoint String true 起動時刻(周期起動時必須)
フォーマット："HH:mm:ss"
expireTime String true タスク終了時間
フォーマット："yyyy-MM-dd HH:mm:ss"
dealType String true 重複処理タイプ
(1：重複チェックなし、2：現在のタスク内)
remark String true 備考
controlOption int true タスクオプション 1: 連絡先なしで自動停止、その他の値は連絡先なしでも自動停止しない

レスポンスパラメータ

パラメータ タイプ 必須 説明
succeed boolean false 処理識別子(現在未使用)
code String false リターンコード
bizCode String false ビジネスコード(現在未使用)
message String false リターンメッセージ
visible boolean false 可視性(現在未使用)
data Object true 結果
data.taskId Long false タスクID
data.contactBatchId Long false 連絡先リストID
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/callTasks/simply?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{

    "callTemplateId": 148,
    "name": "テストタスク",
    "startMode": 2,
    "startTime": "2022-07-20 00:00:00",
    "priority": 2,
    "expireTime": "2022-07-21 23:59:59",
    "remark": "テストタスク",
    "controlOption":"1"
  }'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "taskId": 102321,
        "contactBatchId": 562
    }
}

アウトバウンドタスクリストの検索（基本版）

リクエストURL

リクエストパラメータ

パラメータ タイプ 必須 説明
pageNum int true ページ番号
pageSize int true 1ページあたりの件数、デフォルト20
name String true タスク名
status int true タスクステータス(1:一時停止済み 2:実行中 3:停止済み 4:一時停止中 5:停止中 6:期限切れ)
category int true タスクカテゴリ(1:通常自動発信 2:AI自動発信）

レスポンスパラメータ

パラメータ タイプ 必須 説明
succeed boolean false 処理識別子(現在未使用)
code String false リターンコード
bizCode String false ビジネスコード(現在未使用)
message String false リターンメッセージ
visible boolean false 表示可否(現在未使用)
paging object false ページング情報
paging.pageNum Int false ページ番号
paging.pageSize Int false 1ページあたりの行数
paging.total Int false データ総数
data Array false 結果、検索結果が空の場合は空配列
data.id Long false タスクID
data.name String false タスク名
data.callTemplateId Long false テンプレートID
data.callTemplateName String false テンプレート名
data.category int false タスクカテゴリ(1:通常自動発信 2:AI自動発信)
data.callType int false 発信モード(0:AI発信 1:予測モード 3:精密モード 6:精密IVR 7:純粋IVR 8:AI予測式発信)
data.ivrId Long true 発信IVR ID
data.queueId Long true 発信キュー ID
data.robotDefId Long true シナリオID
data.status int false タスクステータス(1:一時停止済み 2:実行中 3:停止済み 4:一時停止中 5:停止中 6:期限切れ)
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/basicSearch?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb' -i -X POST -H 'Content-Type: application/json' -d '{
    "pageNum":1,
    "pageSize":1,
    "status": 1,
    "name": "外呼任务",
    "category": 2
}'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 1158,
            "name": "外呼任务测试",
            "callTemplateId": 204,
            "callTemplateName": "外呼模板",
            "category": 2,
            "callType": 0,
            "ivrId": null,
            "queueId": null,
            "robotDefId": 10,
            "status": 1
        }
    ]
}

アウトバウンドタスク状態照会インターフェース

リクエストURL

リクエストパラメータ

パラメータ 型 必須 説明
id Long false タスクID（パスパラメータ ）

レスポンスパラメータ

パラメータ 型 必須 説明
succeed boolean false 処理識別子(現在未使用)
code String false リターンコード
bizCode String false ビジネスコード(現在未使用)
message String false リターンメッセージ
visible boolean false 可視性(現在未使用)
data Object true 結果、データがない場合、dataは空
data.name String false タスク名
data.status int false タスク状態(1:一時停止済み 2:実行中 3:停止済み 4:一時停止中 5:停止中 6:期限切れ)
### リクエスト例 
$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/1/status?AppId=18a58d6d-2b4e-44de-5725-31b9e5dbb4b4&Timestamp=1496631984&Token=6d9faaab002f49b2a9b8c634279a7e29414ea1cb'

レスポンス例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "name": "外呼タスクテスト",
        "status": 1
    }
}