CCPaaSアプリケーション側API

共通情報

共通説明

1. インターフェース仕様

1.1 リクエスト形式

Base URL

https://{host}/{Type}/{version}/{api}?Timestamp={Timestamp}&AppId={AppId}&Token={Token}

HTTP ヘッダー

HTTP メソッド

HTTP ステータスコード

1.2 レスポンス形式

共通

正常レスポンス形式

{
    "succeed":true,
    "code":200,
    "bizCode":"000000",
    "message":"OK",
    "visible":false,
    "data":{
        //データ
    }
}

異常レスポンス形式

{
    "succeed":true,
    "code":401,
    "bizCode":"000000",
    "message":"error info",  //異常情報
    "visible":false,
    "data":{
         //データ
    }
}

2 認証方法

認証パラメータ説明

パラメータ名 必須 備考
AppId はい テナントID
Timestamp はい UTCタイムスタンプ、秒単位
Token はい 認証署名、5分間有効

Token は HMAC-SHA1アルゴリズム を使用して暗号化して取得します。暗号化するメッセージはAppId とTimestampを連結して取得し、暗号化に使用するSecretは管理者に連絡して取得する必要があります。

備考: すべてのインターフェース呼び出しには署名パラメータ Token が必要です。Token 値が正当な場合のみリクエストが受け入れられます

例

以下のインターフェースを呼び出すと仮定します：

https://demo.udesk.cn/api/v1/petitions/search

認証に必要なデータは以下の通り：

名称 データ
AppId a54a8b77-f12d-4ac9-742d-5b2bef5c4d11
Timestamp 1612513422
Secret secret-1234567890abc

Tokenの計算 (Javaサンプルコード)


HmacUtils hmacUtils = new HmacUtils(HmacAlgorithms.HMAC_SHA_1, "secret-1234567890abc");
hmacUtils.hmacHex("a54a8b77-f12d-4ac9-742d-5b2bef5c4d11"+"1612513422")


-> Token: e44a3e72aa3bd8cb903f72eacd4126682d1e7ff7

注意:

  1. Token生成は以下のサイトを参考にできます: https://1024tools.com/hmac
  2. このリクエストは自動発信インターフェースであり、Emailパラメータ認証を追加する必要があります。通常のインターフェースはこのパラメータを必要としません

最終的なリクエストURL：

https://demo.udesk.cn/api/v1/petitions/search?AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Timestamp=1612513422&Token=e44a3e72aa3bd8cb903f72eacd4126682d1e7ff

オープンインターフェース

01 アウトバウンドタスクの作成

基本情報

Path： /api/v1/ads/external/callTasks?Email={Email}

Method： POST

インターフェース説明：

概要

自動アウトバウンドタスクを新規追加します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X POST -H 'Content-Type: application/json' -d '{


"name":"テストダイヤル1",
"remark":"テストダイヤル",
"callTemplateId":5,
"ivrId":1,
"queueId":11,
"spnumberType":1,
"spnumberValue":72,
"startMode":1,
"startTime":null,
"workTimeId":31,
"priority":1,
"controlOptionList":[
    1
],
"ivrMode":0,
"callType":1,
"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,
        "ivrId":1,
        "queueId":11,
        "spnumberType":1,
        "spnumberValue":72,
        "startMode":1,
        "startTime":null,
        "workTimeId":31,
        "priority":1,
        "controlOption":"1",
        "controlOptionList":[
            1
        ],
        "status":1,
        "ivrMode":0,
        "callType":1,
        "dialParam":{
            "optimizeParam":1,
            "optimizeTarget":1
        },
        "concurrentLimit":1,
        "taskContactBatchRelList":[
            {
                "contactBatchId":3,
                "callWeight":100
            }
        ],
        "redialSceneList":[
            {
                "result":"ユーザー拒否",
                "dealOption":1,
                "redialTimes":1,
                "redialGuide":1,
                "guideIncrement":1,
                "nextDeal":1
            }
        ]
    }
}

リクエストパラメータ

ヘッダー

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい

ボディ

名称タイプ必須かどうかデフォルト値備考その他の情報
namestring必須タスク名

mock: test

remarkstring必須ではない説明
callTemplateIdnumber必須アウトバウンドテンプレートID

mock: 1

ivrIdnumber必須ではないアウトバウンドIVR ID
queueIdnumber必須ではないアウトバウンドキューID
spnumberTypenumber必須発信者番号タイプ(1:中継番号 2:番号プール)
spnumberValuenumber必須発信者番号の値
startModenumber必須起動方式(1:手動 2:スケジュール 3:周期起動)
startTimestring必須ではない起動時間(スケジュール時はyyyy-MM-dd HH:mm:ss形式)
workTimeIdnumber必須勤務時間ID
prioritynumber必須タスク優先度
controlOptionListnumber []必須ではないタスクオプション集合

item タイプ: number

├─ 必須ではないcontrolOptionList
ivrModenumber必須ではないIVRモード(0:オフ 1:オン)
callTypenumber必須ではないアウトバウンドモード(1:予測モード 3:精密モード 6:精密IVRモード 7:純粋IVRモード)
concurrentLimitnumber必須タスク同時実行数
dialParamobject必須ではないダイヤル設定パラメータ
├─ optimizeParamnumber必須ではない最適化パラメータ(1:エージェント利用率 2:通話放棄率 3:エージェント平均待機時間)
├─ optimizeTargetnumber必須ではない最適化目標
redialSceneListobject []必須ではない再試行オプション集合

item タイプ: object

├─ resultstring必須ではない通話結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,ダイヤル方法不正,着信制限,通話転送失敗,ネットワークビジー,応答なし,料金未払い,通話不可,番号変更,回線障害,後でかけ直し,その他)
├─ dealOptionnumber必須処理方法(1:再ダイヤル)
├─ redialTimesnumber必須ではない再試行回数
├─ redialGuidenumber必須ではない時間間隔(分)
├─ guideIncrementnumber必須ではない間隔増分(分)
├─ nextDealnumber必須後続処理(1:連絡先の次の電話)
├─ typenumber必須通話結果タイプ(1:通話無効 2:通話失敗 3:タグ)
taskContactBatchRelListobject []必須ではない連絡先リスト集合

item タイプ: object

├─ callWeightnumber必須ではない通話重み
├─ contactBatchIdnumber必須ではない連絡先リストID

返却データ

名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在は使用しない)
messagestring必須メッセージ
visibleboolean必須表示可否(現在は使用しない)
dataobject必須ではない結果
├─ idnumber必須タスクID
├─ namestring必須タスク名
├─ remarkstring必須ではない説明
├─ callTemplateIdnumber必須発信テンプレート
├─ ivrIdnumber必須ではない発信IVR ID
├─ queueIdnumber必須ではない発信キューID
├─ spnumberTypenumber必須発信元番号タイプ(1:中継番号 2:番号プール)
├─ spnumberValuenumber必須発信元番号値
├─ startModenumber必須起動方式(1:手動 2:スケジュール 3:周期起動)
├─ startTimenull必須ではない起動時間(スケジュール使用時 yyyy-MM-dd HH:mm:ss)
├─ workTimeIdnumber必須勤務時間ID
├─ prioritynumber必須タスク優先度
├─ controlOptionstring必須ではないタスクオプション
├─ controlOptionListnumber []必須ではないタスクオプション(列挙型整数配列, 1:連絡先なしで自動停止)

item タイプ: number

├─ 必須ではないタスクオプション列挙値
├─ statusnumber必須1: 一時停止済み 2: 実行中 3: 停止済み 4: 一時停止中 5: 停止中
├─ ivrModenumber必須IVRモード(0:オフ 1:オン)
├─ callTypenumber必須発信モード(1:予測モード 3:精密モード 6:精密IVRモード 7:純粋IVRモード)
├─ dialParamobject必須ではないダイヤル設定パラメータ
├─ optimizeParamnumber必須ではない最適化パラメータ(1:オペレータ利用率 2:通話放棄率 3:オペレータ平均待機時間)
├─ optimizeTargetnumber必須ではない最適化目標
├─ concurrentLimitnumber必須ではないタスク同時実行数
├─ taskContactBatchRelListobject []必須ではない連絡先リスト集合

item タイプ: object

├─ contactBatchIdnumber必須ではない連絡先リストID
├─ callWeightnumber必須ではない通話重み
├─ redialSceneListobject []必須ではない再試行オプション集合

item タイプ: object

├─ resultstring必須ではない通話結果(電源オフ, 空番号, サービス停止, 話し中, ユーザー拒否, 接続不可, サービス一時停止, ユーザー通話中, ダイヤル方法不正, 着信制限, 転送失敗, ネットワークビジー, 応答なし, 料金未払い, 通話不可, 番号変更, 回線障害, 後でかけ直し, その ## 02 外呼タスクの編集 ### 基本情報 **Path：** /api/v1/ads/external/callTasks/{id} **Method：** PUT **インターフェース説明：**

概要

自動外呼タスクのデータを修正します。

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/80?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X PUT -H 'Content-Type: application/json' -d '{

    "name":"テストダイヤル1",
    "remark":"テストダイヤル",
    "callTemplateId":5,
    "ivrId":1,
    "queueId":11,
    "spnumberType":1,
    "spnumberValue":72,
    "startMode":1,
    "startTime":null,
    "workTimeId":31,
    "priority":1,
    "controlOptionList":[
        1
    ],
    "ivrMode":0,
    "callType":1,
    "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,
        "ivrId":1,
        "queueId":11,
        "spnumberType":1,
        "spnumberValue":72,
        "startMode":1,
        "startTime":null,
        "workTimeId":31,
        "priority":1,
        "controlOption":"1",
        "controlOptionList":[
            1
        ],
        "status":1,
        "ivrMode":0,
        "callType":1,
        "dialParam":{
            "optimizeParam":1,
            "optimizeTarget":1
        },
        "concurrentLimit":1,
        "taskContactBatchRelList":[
            {
                "contactBatchId":3,
                "callWeight":100
            }
        ],
        "redialSceneList":[
            {
                "result":"ユーザー拒否",
                "dealOption":1,
                "redialTimes":1,
                "redialGuide":1,
                "guideIncrement":1,
                "nextDeal":1
            }
        ]
    }
}
### リクエストパラメータ **ヘッダー** | パラメータ名 | パラメータ値 | 必須かどうか | 例 | 備考 | | ------------ | ------------ | ------------ | ------------ | ------------ | | Content-Type | application/json | はい | | | **パスパラメータ** | パラメータ名 | 例 | 備考 | | ------------ | ------------ | ------------ | | id | 1 | タスクID | **ボディ**
名称タイプ必須かどうかデフォルト値備考その他の情報
namestring必須ではないタスク名

mock: test

remarkstring必須ではない説明
callTemplateIdnumber必須ではない発信テンプレートID

mock: 1

ivrIdnumber必須ではない発信IVR ID
queueIdnumber必須ではない発信キューID
spnumberTypenumber必須発信元番号タイプ(1:中継番号 2:番号プール)
spnumberValuenumber必須ではない発信元番号値
startModenumber必須ではない起動方式(1:手動 2:スケジュール 3:周期起動)
startTimestring必須ではない起動時間(スケジュール時はyyyy-MM-dd HH:mm:ss形式)
workTimeIdnumber必須ではない勤務時間ID
prioritynumber必須ではないタスク優先度
controlOptionListnumber []必須ではないタスクオプション集合

item タイプ: number

├─ 必須ではないcontrolOptionList
ivrModenumber必須ではないIVRモード(0:オフ 1:オン)
callTypenumber必須発信モード(1:予測モード 3:精密モード 6:精密IVRモード 7:純粋IVRモード)
concurrentLimitnumber必須ではないタスク同時実行数
dialParamobject必須ではないダイヤル設定パラメータ
├─ optimizeParamnumber必須ではない最適化パラメータ(1:オペレータ利用率 2:放棄通話率 3:オペレータ平均待機時間)
├─ optimizeTargetnumber必須ではない最適化目標
redialSceneListobject []必須ではない再試行オプション集合

item タイプ: object

├─ resultstring必須ではない通話結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,ダイヤル方法不正,着信制限,通話転送失敗,ネットワークビジー,応答なし,料金未払い,通話不可,番号変更,回線障害,後でかけ直し,その他)
├─ dealOptionnumber必須ではない処理方法(1:再ダイヤル)
├─ redialTimesnumber必須ではない再試行回数
├─ redialGuidenumber必須ではない時間間隔(分)
├─ guideIncrementnumber必須ではない間隔増分(分)
├─ nextDealnumber必須ではない後続処理(1:連絡先の次の電話)
├─ typestring必須ではない通話結果タイプ(1:通話無効 2:通話失敗 3:タグ)
taskContactBatchRelListobject []必須ではない連絡先リスト集合

item タイプ: object

├─ callWeightnumber必須ではない通話重み
├─ contactBatchIdnumber必須連絡先リストID
### 返却データ ### 基本情報 **Path：** /api/v1/ads/external/callTasks/status/{id}/executing **Method：** PUT **インターフェース説明：**

概要

アウトバウンドタスクを開始します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/executing?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -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
}
### リクエストパラメータ **Headers** | パラメータ名 | パラメータ値 | 必須かどうか | 例 | 備考 | | ------------ | ------------ | ------------ | ------------ | ------------ | | Content-Type | application/x-www-form-urlencoded | はい | | | **パスパラメータ** | パラメータ名 | 例 | 備考 | | ------------ | ------------ | ------------ | | id | 1 | タスクID | ### レスポンスデータ
名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在は使用しない)
messagestring必須メッセージ
visibleboolean必須表示可否(現在は使用しない)
dataobject必須ではない結果
├─ idnumber必須タスクID
├─ namestring必須タスク名
├─ remarkstring必須ではない説明
├─ callTemplateIdnumber必須発信テンプレート
├─ ivrIdnumber必須ではない発信IVR ID
├─ queueIdnumber必須ではない発信キューID
├─ spnumberTypenumber必須発信元番号タイプ(1:中継番号 2:番号プール)
├─ spnumberValuenumber必須発信元番号値
├─ startModenumber必須起動方式(1:手動 2:スケジュール 3:周期起動)
├─ startTimenull必須ではない起動時間(スケジュール使用時 yyyy-MM-dd HH:mm:ss)
├─ workTimeIdnumber必須勤務時間ID
├─ prioritynumber必須タスク優先度
├─ controlOptionstring必須ではないタスクオプション
├─ controlOptionListnumber []必須ではないタスクオプション(列挙整数配列, 1:連絡先なしで自動停止)

item タイプ: number

├─ 必須ではないタスクオプション列挙値
├─ statusnumber必須1: 一時停止済み 2: 実行中 3: 停止済み 4: 一時停止中 5: 停止中
├─ ivrModenumber必須IVRモード(0:オフ 1:オン)
├─ callTypenumber必須発信モード(1:予測モード 3:精密モード 6:精密IVRモード 7:純粋IVRモード)
├─ dialParamobject必須ではないダイヤル設定パラメータ
├─ optimizeParamnumber必須ではない最適化パラメータ(1:オペレータ利用率 2:通話放棄率 3:オペレータ平均待機時間)
├─ optimizeTargetnumber必須ではない最適化目標
├─ concurrentLimitnumber必須ではないタスク並列数
├─ taskContactBatchRelListobject []必須ではない連絡先リスト集合

item タイプ: object

├─ contactBatchIdnumber必須ではない連絡先リストID
├─ callWeightnumber必須ではない発信重み
├─ redialSceneListobject []必須ではない再試行オプション集合

item タイプ: object

├─ resultstring必須ではない通話結果(電源オフ,空番号,サービス停止,話し中,ユーザー拒否,接続不可,サービス一時停止,ユーザー通話中,ダイヤル方式不正,着信制限,転送失敗,ネットワークビジー,応答なし,料金未払い,通話不可,番号変更,回線障害,後でかけ直し,その他)
名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在は使用しません)
messagestring必須メッセージ
visibleboolean必須表示可否(現在は使用しません)

04 アウトバウンドタスクの一時停止

基本情報

Path： /api/v1/ads/external/callTasks/status/{id}/pause

Method： PUT

インターフェース説明：

概要

アウトバウンドタスクを一時停止します。

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/pause?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -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
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/x-www-form-urlencoded 必須

パスパラメータ

パラメータ名 例 備考
id 1 タスクID

レスポンスデータ

名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在未使用)
messagestring必須メッセージ
visibleboolean必須表示可否(現在未使用)

05 発信タスクの停止

基本情報

Path： /api/v1/ads/external/callTasks/status/{id}/stop

Method： PUT

インターフェース説明：

概要

発信タスクを停止します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/callTasks/status/1/stop?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -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
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/x-www-form-urlencoded はい

パスパラメータ

パラメータ名 例 備考
id 1 タスクID

レスポンスデータ

名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在は使用されていません)
messagestring必須メッセージ
visibleboolean必須表示/非表示(現在は使用されていません)

06 コンタクトリストの作成

基本情報

Path： /api/v1/ads/external/contactBatchs

Method： POST

インターフェース説明：

概要

コンタクトリストを作成します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/contactBatchs?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -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
    }
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい
Body
名前タイプ必須かどうかデフォルト値備考その他の情報
namestring必須コンタクトリスト名
remarkstring必須ではない備考
focusstring必須ではないタグ
callTaskIdstring必須アウトバウンドタスクID

返却データ

名称型必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在未使用)
messagestring必須メッセージ
visibleboolean必須表示可否(現在未使用)
dataobject必須ではない結果
├─ idstring必須連絡票ID
├─ namestring必須連絡票名
├─ remarkstring必須ではない備考
├─ focusstring必須ではないタグ
├─ statusstring必須ステータス(1:待機中 2:インポート中 3:完了)

07 連絡先番号のインポート

基本情報

Path： /api/v1/ads/external/contactBatchs/syncNumber

Method： POST

インターフェース説明：

概要

連絡先番号インポートインターフェース（1回あたり最大50件）

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/ads/external/contactBatchs/syncNumber?Email=1@test.cn&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -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":"番号が無効です"
           }
       ]
    }
}

リクエストパラメータ

ヘッダー

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい

ボディ

名称タイプ必須かどうかデフォルト値備考その他の情報
contactBatchIdnumber必須連絡票ID
dealTypenumber必須ではない重複処理タイプ(1:重複チェックなし 2:現在のタスク)
encryptionFlagnumber必須0暗号化するか(1: はい 0: いいえ)
algorithmTypenumber必須ではない暗号化アルゴリズム(1: AES, 2: DES)
secretKeystring必須ではない暗号化キー(base64で暗号化が必要)
encryptionRangelist必須ではない暗号化フィールド
numberListobject []必須電話番号リストの集合

item タイプ: object

├─ namestring必須連絡先名
├─ mobilestring必須携帯電話番号
├─ companyNamestring必須ではない会社
├─ remarkstring必須ではない備考
├─ variatesobject []必須ではないカスタム変数

item タイプ: object

├─ keystring必須ではない変数
├─ typestring必須ではない変数タイプ
├─ valuestring必須ではない変数値

返却データ

名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード(現在は使用しない)
messagestring必須メッセージ
visibleboolean必須表示可否(現在は使用しない)
dataobject必須ではない結果
├─ contactBatchIdnumber必須連絡先バッチID
├─ successCountnumber必須インポート成功した番号の数
├─ failedCountnumber必須インポート失敗した番号の数
├─ failedNumberListobject []必須ではないインポート失敗した番号の集合

item タイプ: object

├─ namestring必須ではない氏名
├─ mobilestring必須ではない番号
├─ companyNamestring必須ではない会社
├─ remarkstring必須ではない備考
├─ variatesstring []必須ではないカスタム変数(フォーマット:[{"key":"天気","type":"string","value":"北京"}])

item タイプ: string

├─ failedReasonstring必須ではない失敗理由
├─ dealType number必須ではない重複処理タイプ(1:重複チェックなし 2:現在のタスク)
├─ encryptionFlag number必須暗号化フラグ
├─ algorithmType number必須ではない暗号化タイプ
├─ encryptionRange list必須ではない暗号化フィールド
├─ encryptionField string必須ではない暗号化フィールド

08 通話記録検索

基本情報

Path： /api/v1/petitions/search

Method： POST

インターフェース説明：

概要

通話記録を検索します。時間範囲、通話タイプ、callidによる検索をサポートしています。検索時間範囲は7日を超えることはできず、時間範囲が広いほど検索時間が長くなります。できるだけ検索範囲を短くしてください。

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/petitions/search？AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X POST -H 'Content-Type: application/json' -d '{
   "pageNum": 1,
   "pageSize": 1,
   "startTime": "2021-06-26 00:00:28",
   "endTime": "2021-06-26 10:00:28",
   "category": 2,
   "callId": "d44539e0-3d41-4854-83da-d22a0d251304"
}'
レスポンス
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": 16938727,
            "callId": "d44539e0-3d41-4854-83da-d22a0d251304",
            "category": 2,
            "customerNumber": "18710180975",
            "beginAt": "2021-06-26 00:09:28",
            "endAt": "2021-06-26 00:09:51",
            "defeatCause": null,
            "displayNumber": "04536341334",
            "agentName": "テスト",
            "customerRingingTime": 0,
            "talkRecord": "https://s4-ccps-pri-std.obs.cn-north-4.myhuaweicloud.com/c055e127-95d0-44f0-7564-5f570d410b68/cc_recordings/20210626000945_d44539e0-3d41-4854-83da-d22a0d251304_a5138e4d-5eec-4d5f-bc1d-6cf9c5a0eacf_18710180975.mp3?AWSAccessKeyId=KNERXMMZRQZ7UHV2OSEN&Expires=1656173390&Signature=Pb%2BSiPvi9GtFvLIm98nyJV0CHZE%3D",
            "outLineNumber": "",
            "talkTime": 5,
            "followUpCall": "なし",
            "queueName": "劉勇-キュー",
            "queueResult": "キューイング成功",
            "ringResult": "オペレーター応答",
            "seqRing": "0",
            "outCallRingTime": null,
            "outCallDefeatCause": null,
            "hangupBy": "オペレーター",
            "callResult": "オペレーター応答",
            "agentInfo": {
                "id": 10001,
                "name": "テスト",
                "employeeId": "オペレーター-001",
                "number": "99674238501001"
            },
            "talkInfo": null,
            "ivrInfo": null,
            "phoneInfo": null,
            "queueInfo": null,
            "surveryList": [
                "評価済み-1-12"
            ]
        }
    ]
}

リクエストパラメータ

ヘッダー

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい

ボディ

名称タイプ必須かどうかデフォルト値備考その他の情報
pageNumnumber必須ではないページ番号
pageSizenumber必須ではない1ページあたりの行数
startTimestring必須ではない開始時間、例: 2021-02-24 18:50:00
endTimestring必須ではない終了時間、例: 2021-02-24 19:50:00
categorynumber必須ではない通話タイプ 1: 発信 2： 着信
callIdstring必須ではない通話の一意識別子

返却データ

名称型必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード。200成功
bizCodestring必須bizcode
messagestring必須メッセージ
visibleboolean必須visible
pagingobject必須ページ情報
├─ pageNumnumber必須ページ番号
├─ pageSizenumber必須1ページあたりの行数
├─ totalnumber必須総数
dataobject []必須ではない結果データ

item 型: object

├─ idnumber必須一意のシーケンス
├─ callIdstring必須通話ID
├─ categorynumber必須通話タイプ 1: 発信 2： 着信
├─ customerNumberstring必須ではない顧客電話番号
├─ beginAtstring必須通話開始時間
├─ endAtstring必須終了時間
├─ displayNumberstring必須ではない中継番号
├─ agentNamestring必須ではないオペレーター名
├─ customerRingingTimenumber必須ではない顧客呼出音継続時間
├─ talkRecordstring必須ではない通話録音
├─ outLineNumberstring必須ではない外線番号
├─ talkTimenumber必須ではない通話時間（秒）
├─ followUpCallstring必須ではないフォローアップ通話
├─ queueNamestring必須ではないキュー名
├─ queueResultstring必須ではないキュー結果
├─ ringResultstring必須ではない呼出結果
├─ seqRingstring必須ではない順次呼出
├─ outCallRingTimestring必須ではない発信呼出継続時間
├─ outCallDefeatCausestring必須ではない発信失敗原因
├─ hangupBystring必須ではない切断側
├─ callResultstring必須ではない通話結果
├─ agentInfoobject必須ではないオペレーター情報
├─ idnumber必須ではないオペレーターID
├─ namestring必須ではないオペレーター名
├─ employeeIdstring必須ではないオペレーター社員番号
├─ numberstring必須ではないオペレーター内線番号 ### 基本情報 **Path：** /api/v1/petitions/callId **Method：** GET **インターフェース説明：**

概要

通話記録詳細照会

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/petitions/callId?callId=d44539e0-3d41-4854-83da-d22a0d251304&AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd'
レスポンス
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": 16938727,
        "callId": "d44539e0-3d41-4854-83da-d22a0d251304",
        "category": 2,
        "customerNumber": "18710180975",
        "beginAt": "2021-06-26 00:09:28",
        "endAt": "2021-06-26 00:09:51",
        "defeatCause": null,
        "displayNumber": "04536341334",
        "agentName": "テスト",
        "customerRingingTime": 0,
        "talkRecord": "https://s4-ccps-pri-std.obs.cn-north-4.myhuaweicloud.com/c055e127-95d0-44f0-7564-5f570d410b68/cc_recordings/20210626000945_d44539e0-3d41-4854-83da-d22a0d251304_a5138e4d-5eec-4d5f-bc1d-6cf9c5a0eacf_18710180975.mp3?AWSAccessKeyId=KNERXMMZRQZ7UHV2OSEN&Expires=1656173390&Signature=Pb%2BSiPvi9GtFvLIm98nyJV0CHZE%3D",
        "outLineNumber": "",
        "talkTime": 5,
        "followUpCall": "なし",
        "queueName": "テスト-キュー",
        "queueResult": "キューイング成功",
        "ringResult": "オペレーター応答",
        "seqRing": "0",
        "outCallRingTime": null,
        "outCallDefeatCause": null,
        "hangupBy": "オペレーター",
        "callResult": "オペレーター応答",
        "agentInfo": {
            "id": 781,
            "name": "テスト",
            "employeeId": "オペレーター-001",
            "number": "98674238501001"
        },
        "talkInfo": {
            "beginAt": "2021-06-26 00:09:45",
            "endAt": "2021-06-26 00:09:51",
            "record": "https://s4-ccps-pri-std.obs.cn-north-4.myhuaweicloud.com/c055e127-95d0-44f0-7564-5f570d410b68/cc_recordings/20210626000945_d44539e0-3d41-4854-83da-d22a0d251304_a5138e4d-5eec-4d5f-bc1d-6cf9c5a0eacf_18710180975.mp3?AWSAccessKeyId=KNERXMMZRQZ7UHV2OSEN&Expires=1656173390&Signature=Pb%2BSiPvi9GtFvLIm98nyJV0CHZE%3D",
            "talkTime": 5,
            "hangupBy": "オペレーター",
            "numOfAgentHold": 0,
            "numOfAgentSilence": 0,
            "numOfAgentToIvr": 0,
            "numOfAgentTransfer": 0,
            "numOfAgentAdvisory": 0,
            "numOfAgentThird": 0,
            "agentEvents": [],
            "category": 0
        },
        "ivrInfo": {
            "record": null,
            "variables": null,
            "lables": null,
            "ivrTimes": 30,
            "process": [
                {
                    "seq": 1,
                    "beginAt": "2021-06-26 00:09:28",
                    "endAt": "2021-06-26 00:09:58",
                    "ivrName": null,
                    "ivrLog": null
                }
            ]
        },
        "phoneInfo": {
            "number": "18710710970",
            "province": "北京",
            "city": "北京",
            "operator": null
        },
        "queueInfo": {
            "enterQueue": null,
            "enterRule": null,
            "enterEvent": null,
            "repeatCusterRule": "",
            "queueType": "キュー",
            "queueId": 2411,
            "queueName": "テスト-キュー",
            "customerLevel": null,
            "callLevel": null,
            "enterAt": "2021-06-26 00:09:31",
            "queueTime": 14,
            "assignAt": "2021-06-26 00:09:45",
            "assignRule": null,
            "continuousRingTime": null,
            "lastAgentRingTime": 15,
            "numOfSeqRing": 0,
            "seqRingEvent": null,
            "queueResult": "キューイング成功",
            "ringResult": "オペレーター応答"
        },
        "surveryList": [
            "評価済み-1-12"
        ]
    }
}
### リクエストパラメータ **ヘッダー** | パラメータ名 | パラメータ値 | 必須かどうか | 例 | 備考 | | ------------ | ------------ | ------------ | ------------ | ------------ | | Content-Type | application/json | はい | | | **クエリ** | パラメータ名 | 必須かどうか | 例 | 備考 | | ------------ | ------------ | ------------ | ------------ | | callId | はい | d44539e0-3d41-4854-83da-d22a0d251304 | | ### レスポンスデータ
名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード。200成功
bizCodestring必須bizcode
messagestring必須メッセージ
visibleboolean必須visible
dataobject必須ではない結果
├─ idnumber必須一意のシーケンス
├─ callIdstring必須通話ID
├─ categorynumber必須通話タイプ 1: 発信 2： 着信
├─ customerNumberstring必須ではない顧客電話番号
├─ beginAtstring必須通話開始時間
├─ endAtstring必須終了時間
├─ displayNumberstring必須ではない中継番号
├─ agentNamestring必須ではないオペレーター名
├─ customerRingingTimenumber必須ではない顧客呼び出し時間
├─ talkRecordstring必須ではない通話録音
├─ outLineNumberstring必須ではない外線番号
├─ talkTimenumber必須ではない通話時間（秒）
├─ followUpCallstring必須ではないフォローアップ通話
├─ queueNamestring必須ではないキュー名
├─ queueResultstring必須ではないキュー結果
├─ ringResultstring必須ではない呼び出し結果
├─ seqRingstring必須ではない順次呼び出し
├─ outCallRingTimestring必須ではない発信呼び出し時間
├─ outCallDefeatCausestring必須ではない発信失敗原因
├─ hangupBystring必須ではない切断側
├─ callResultstring必須ではない通話結果
├─ agentInfoobject必須ではないオペレーター情報
├─ idnumber必須ではないオペレーターID
├─ namestring必須ではないオペレーター名
├─ employeeIdstring必須ではないオペレーター社員番号
├─ numberstring必須ではないオペレーター内線番号
├─ talkInfoobject必須ではない通話情報
├─ beginAtstring必須ではない通話開始時間、yyyy-mm-dd HH:mm:ss形式
├─ endAt ### 基本情報 **Path：** /api/v1/calllimit/{callType}/numbers **Method：** POST **インターフェース説明：**

概要

通話制限番号を追加します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/in/numbers?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X POST-H 'Content-Type: application/json'  -d '{
    "numberInputModel": 1,
    "numbers": [
        "17000000000"
    ],
    "limitType": "forever"
}'

レスポンス

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": {
        "totalSize": 1,
        "repeatSize": 1,
        "repeatList": [
            "17000000000"
        ]
    }
}
### リクエストパラメータ **Headers** | パラメータ名 | パラメータ値 | 必須かどうか | 例 | 備考 | | ------------ | ------------ | ------------ | ------------ | ------------ | | Content-Type | application/json | はい | | | **パスパラメータ** | パラメータ名 | 例 | 備考 | | ------------ | ------------ | ------------ | | callType | in | 通話タイプ in: 着信 out:発信 | **Body**
名称タイプ必須かどうかデフォルト値備考その他の情報
numberInputModelnumber必須番号入力方式、デフォルトは1
numbersstring []必須番号配列

item タイプ: string

├─ 必須ではない単一の番号
limitTypestring必須制限タイプ 永久制限 :forever 分:minute 時間: hour 日:day 週：week 月:month 年:year
limitTimenumber必須ではない制限時間（limitTypeがforeverの場合は必須ではなく、それ以外の値の場合は必須）
limitReasonstring必須ではない制限理由

返却データ

名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須ではない成功フラグ
codenumber必須ではない結果コード
bizCodestring必須ではないbizcode
messagestring必須ではないメッセージ
visibleboolean必須ではない表示可否
dataobject必須
├─ totalSizenumber必須総数
├─ repeatSizenumber必須データベース内の重複数
├─ repeatListstring []必須重複コレクション

item タイプ: string

├─ 必須ではない重複番号

11 通話制限番号検索

基本情報

Path： /api/v1/calllimit/{callType}/numbers/search

Method： GET

インターフェース説明：

概要

通話制限番号を検索します。ページング検索をサポートしています。

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/{callType}/numbers/search?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd&pageNum=1&pageSize=20'

レスポンス

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": 20,
        "total": 1
    },
    "data": [
        {
            "id": 100,
            "number": "18710180977",
            "numberInputModel": 1,
            "limitType": "foever",
            "limitTime": null,
            "unlimitTime": null,
            "limitReason": null,
            "createdAt": "2021-07-17 19:11:16",
            "updatedAt": "2021-07-17 19:11:20",
            "createdUserId": null,
            "updatedUserId": null
        }
    ]
}

リクエストパラメータ

パスパラメータ

パラメータ名 例 備考
callType in in:着信 out: 発信

クエリパラメータ

パラメータ名 必須 例 備考
pageNum いいえ 1 ページ番号
pageSize いいえ 20 1ページあたりの行数
keyword いいえ 1871018 キーワード（番号）。あいまい検索をサポートします。
### 返却データ
名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須bizCode
messagestring必須メッセージ
visibleboolean必須表示可否
pagingobject必須ページ情報
├─ pageNumnumber必須ページ番号
├─ pageSizenumber必須1ページあたりの行数
├─ totalnumber必須総数
dataobject []必須制限番号データ

item タイプ: object

├─ idnumber必須一意の識別子
├─ numberstring必須番号
├─ createdAtstring必須追加時間
├─ limitTypestring必須制限タイプ 永久:forever 分 : minute 時間 : hour  日:day 週：week 月:month 年:year
├─ unlimitTimestring必須ではない制限解除時間
├─ limitReasonstring必須制限理由

12 電話番号による番号詳細の取得

基本情報

Path： /api/v1/calllimit/{callType}/tel/{number}

Method： GET

インターフェース説明：

概要

電話番号により番号の詳細情報を取得します。

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/in/tel/17000000000?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd'

レスポンス

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": 100,
        "number": "17000000000",
        "numberInputModel": 1,
        "limitType": "foever",
        "limitTime": null,
        "unlimitTime": null,
        "limitReason": null,
        "createdAt": "2021-07-17 19:11:16",
        "updatedAt": "2021-07-17 19:11:20",
        "createdUserId": null,
        "updatedUserId": null
    }
}

リクエストパラメータ

パスパラメータ

パラメータ名 例 備考
callType in 通話タイプ in: 着信 out:発信
number 17000000000 番号

レスポンスデータ

名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須bizCode
messagestring必須メッセージ
visibleboolean必須表示可否
dataobject必須データ
├─ idnumber必須一意の識別子
├─ numberstring必須番号
├─ numberInputModelnumber必須番号入力方式 1:手動入力 2:一括インポート 3:正規表現入力
├─ limitTypestring必須制限タイプ 永久制限:forever 分:minute 時間:hour 日:day 週：week 月:month 年:year
├─ limitTimenumber必須制限時間
├─ unlimitTimestring必須制限解除時間
├─ limitReasonstring必須制限理由
├─ createdAtstring必須作成時間
├─ updateAtstring必須更新時間
├─ createdUserIdstring必須作成ユーザー
├─ updateUserIdstring必須更新ユーザー

13 電話番号による制限番号情報の変更

基本情報

Path： /api/v1/calllimit/{callType}/tel/{number}

Method： PUT

インターフェース説明：

概要

電話番号を通じて制限番号情報を変更します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/in/tel/17000000000?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X PUT-H 'Content-Type: application/json'  -d '{
    "limitType": "day",
    "limitTime": 1,
    "limitReason":"テスト"
}'

レスポンス

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": {
        "number": "17000000000",
        "limitType": "day",
        "limitTime": 1,
        "limitReason": "テスト"
    }
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい
パスパラメータ
パラメータ名 例 備考
callType in 通話タイプ in:着信 out: 発信
number 17000000000 番号

Body

名称タイプ必須かどうかデフォルト値備考その他の情報
limitTypestring必須制限タイプ 永久:forever 分:minute 時間: hour 日:day 週：week 月:month 年:year
limitTimenumber必須ではない制限時間
limitReasonstring必須ではない制限理由

返却データ

名称型必須かデフォルト値備考その他の情報
succeedboolean必須ではない成功フラグ
codenumber必須ではない結果コード
bizCodestring必須ではないbizcode
messagestring必須ではないメッセージ
visibleboolean必須ではない表示可否
dataobject必須ではない
├─ numberstring必須ではない番号
├─ limitTypestring必須ではない制限タイプ 永久制限 :forever 分:minute 時間: hour 日:day 週：week 月:month 年:year
├─ limitTimenumber必須ではない制限時間
├─ limitReasonstring必須ではない制限理由

14 電話番号による制限番号情報の削除

基本情報

Path： /api/v1/calllimit/{callType}/tel/{number}

Method： DELETE

インターフェース説明：

概要

電話番号により制限番号情報を削除します

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/in/tel/17000000000?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X DELETE

レスポンス

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
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/x-www-form-urlencoded はい

パスパラメータ

パラメータ名 例 備考
callType in 通話タイプ in: 着信 out: 発信
number 18920765652 番号ID

レスポンスデータ

名称タイプ必須かどうかデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須bizCode
messagestring必須メッセージ
visibleboolean必須表示可否

15 携帯電話番号による制限番号の一括削除

基本情報

Path： /api/v1/calllimit/{callType}/tel/batch-delete

Method： PUT

インターフェース説明：

概要

携帯電話番号による制限番号の一括削除

例

リクエスト

$ curl 'https://demo.udesk.cn/api/v1/calllimit/in/tel/batch-delete?AppId=1234567890abc&Timestamp=1496631984&Token=4c1947cb3d87743b613f3a4843ae74306529d4fd' -i -X PUT -H 'Content-Type: application/json'  -d  '{
    "numbers": [
        "17000000000"
    ]
}'

レスポンス

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
}

リクエストパラメータ

Headers

パラメータ名 パラメータ値 必須かどうか 例 備考
Content-Type application/json はい

パスパラメータ

パラメータ名 例 備考
callType in コールタイプ in:着信 out: 発信

Body

名称タイプ必須かどうかデフォルト値備考その他の情報
numbersstring []必須複数の番号ID

item タイプ: string

├─ 必須ではない番号

レスポンスデータ

名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須bizCode
messagestring必須メッセージ
visibleboolean必須表示可否

文档反馈

标记内容

点击可标注

错误原因:

问题描述:

联系方式(选填):

确定 取消

Copyright © 2019, Udesk

Documentation built with MkDocs.