CCPaaS应用侧API

公共信息

通用说明

1. 接口规范

1.1 请求格式

Base URL

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

HTTP Header

HTTP METHOD

HTTP Status Code

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
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
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非必须外呼IVRid
├─ 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非必须呼叫结果(关机,空号,停机,占线,用户拒接,无法接通,暂停服务,用户正忙,拨号方式不正确,呼入限制,呼叫转移失败,网络忙,无人接听,欠费,无法接听,改号,线路故障,稍后再拨,其他)
├─ dealOptionnumber必须处理方式(1重拨)
├─ redialTimesnumber非必须重试次数
├─ redialGuidenumber非必须时间间隔(分钟)
├─ guideIncrementnumber非必须间隔增量(分钟)
├─ nextDealnumber非必须后续处理(1联系人下一电话)
├─ typestring非必须呼叫结果类型(1呼叫无效2呼叫失败3标签)
├─ validstring非必须是否有效(默认为无效-2)
├─ labelInfosstring []非必须标签

item 类型: string

├─ 非必须

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
            }
        ]
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

路径参数

参数名称 示例 备注
id 1 任务id

Body

名称类型是否必须默认值备注其他信息
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

返回数据

名称类型是否必须默认值备注其他信息
succeedboolean必须成功标识
codenumber必须结果码
bizCodestring必须业务码(暂不使用)
messagestring必须消息
visibleboolean必须是否可见(暂不使用)
dataobject非必须结果
├─ idnumber必须任务id
├─ namestring必须任务名称
├─ remarkstring非必须描述
├─ callTemplateIdnumber必须外呼模板
├─ ivrIdnumber非必须外呼IVRid
├─ 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非必须呼叫结果(关机,空号,停机,占线,用户拒接,无法接通,暂停服务,用户正忙,拨号方式不正确,呼入限制,呼叫转移失败,网络忙,无人接听,欠费,无法接听,改号,线路故障,稍后再拨,其他)
├─ dealOptionnumber必须处理方式(1重拨)
├─ redialTimesnumber非必须重试次数
├─ redialGuidenumber非必须时间间隔(分钟)
├─ guideIncrementnumber非必须间隔增量(分钟)
├─ nextDealnumber非必须后续处理(1联系人下一电话)

03 启动外呼任务

基本信息

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必须是否可见(暂不使用)

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

接口描述：

概述

导入联系人号码接口(单次上限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":"号码无效"
           }
       ]
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
contactBatchIdnumber必须联系单id
dealTypenumber非必须重复处理类型(1全局2所有任务3当前任务4不查重)
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所有任务3当前任务4不查重)
├─ 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"
            ]
        }
    ]
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pageNumnumber非必须页码
pageSizenumber非必须每页行数
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必须每页行数
├─ totalnumber必须总数
dataobject []非必须结果数据

item 类型: object

├─ idnumber必须唯一序列
├─ callIdstring必须通话id
├─ categorynumber必须呼叫类型 1: 呼出 2： 呼入
├─ customerNumberstring非必须客户电话
├─ beginAtstring必须呼叫时间
├─ endAtstring必须结束时间
├─ displayNumberstring非必须中继号
├─ agentNamestring非必须坐席名称
├─ customerRingingTimenumber非必须客户振铃时长
├─ talkRecordstring非必须通话录音
├─ outLineNumberstring非必须外线号码
├─ talkTimenumber非必须通话时长s
├─ followUpCallstring非必须后续通话
├─ queueNamestring非必须队列名称
├─ queueResultstring非必须排队结果
├─ ringResultstring非必须振铃结果
├─ seqRingstring非必须顺振
├─ outCallRingTimestring非必须外呼振铃时长
├─ outCallDefeatCausestring非必须外呼失败原因
├─ hangupBystring非必须挂断方
├─ callResultstring非必须通话结果
├─ agentInfoobject非必须坐席信息
├─ idnumber非必须坐席id
├─ namestring非必须坐席名称
├─ employeeIdstring非必须坐席工号
├─ numberstring非必须坐席分机
├─ talkInfoobject非必须电话信息
├─ beginAtstring非必须开始时间
├─ endAtstring非必须结束时间
├─ recordstring非必须记录
├─ talkTimenumber非必须通话时长
├─ hangupBystring非必须挂断方
├─ numOfAgentHoldnumber非必须坐席保持次数
├─ numOfAgentSilencestring非必须坐席静音次数
├─ numOfAgentToIvrnumber非必须坐席转IVR次数
├─ field_10numOfAgentTransfernumber非必须坐席转接次数
├─ numOfAgentAdvisorynumber非必须坐席咨询次数
├─ numOfAgentThirdnumber非必须坐席三方次数
├─ agentEventsstring []非必须坐席通话中事件

item 类型: string

├─ 非必须
├─ categorynumber非必须通话类型
├─ ivrInfoobject非必须IVR信息
├─ recordstring非必须IVR通话记录录音
├─ variablesstring []非必须IVR变量列表

item 类型: string

├─ 非必须
├─ viewCallVariablesListstring []非必须IVR变量

item 类型: string

├─ 非必须
├─ lablesstring []非必须IVR标签列表

item 类型: string

├─ 非必须
├─ ivrTimesnumber非必须IVR停留时长
├─ processobject []非必须ivr事件流程

item 类型: object

├─ seqnumber非必须序号
├─ beginAtstring非必须进入时间
├─ endAtstring非必须退出时间
├─ ivrNamestring非必须节点名称
├─ ivrLogstring非必须节点日志
├─ phoneInfoobject非必须客户电话信息
├─ numberstring非必须电话号码
├─ provincestring非必须所属省
├─ citystring非必须所属城市
├─ operatorstring非必须运营商
├─ queueInfoobject非必须队列信息
├─ enterQueuenumber非必须入队节点
├─ enterRulestring非必须入队规则
├─ enterEventstring非必须入队事件
├─ repeatCusterRulestring非必须回头客规则
├─ queueTypestring非必须队列类型
├─ queueIdnumber非必须队列ID
├─ queueNamestring非必须队列名称
├─ customerLevelnumber非必须客户等级
├─ callLevelnumber非必须呼叫等级
├─ enterAtstring非必须入队时间
├─ queueTimenumber非必须排队时长
├─ assignAtstring非必须分配时间
├─ assignRulestring非必须分配规则
├─ continuousRingTimenumber非必须连续振铃时长
├─ lastAgentRingTimenumber非必须最后坐席振铃时长
├─ numOfSeqRingnumber非必须顺振次数
├─ seqRingEventstring非必须顺振事件
├─ queueResultstring非必须排队结果
├─ ringResultstring非必须振铃结果
├─ surveryListstring []非必须满意度调查信息

item 类型: string

├─ 非必须
├─ messageUrlstring非必须留言
├─ adTaskNamestring非必须自动外呼任务名称
├─ externFlagstring非必须是否转外线
├─ validFlagstring非必须话有效性(0不做判断1有效2无效)
├─ viewCallVariablesListstring []非必须IVR变量

item 类型: string

├─ 非必须
├─ allRecordUrlListobject []非必须全部录音

item 类型: object

├─ recordUrlstring非必须录音地址
├─ recordTypestring非必须类型
├─ totalIvrTimenumber非必须ivr总时长

09 通话详情查询

基本信息

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"
        ]
    }
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
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非必须通话时长s
├─ followUpCallstring非必须后续通话
├─ queueNamestring非必须队列名称
├─ queueResultstring非必须排队结果
├─ ringResultstring非必须振铃结果
├─ seqRingstring非必须顺振
├─ outCallRingTimestring非必须外呼振铃时长
├─ outCallDefeatCausestring非必须外呼失败原因
├─ hangupBystring非必须挂断方
├─ callResultstring非必须通话结果
├─ agentInfoobject非必须坐席信息
├─ idnumber非必须坐席id
├─ namestring非必须坐席名称
├─ employeeIdstring非必须坐席工号
├─ numberstring非必须坐席分机
├─ talkInfoobject非必须通话信息
├─ beginAtstring非必须通话开始时间，yyyy-mm-dd HH:mm:ss格式
├─ endAtstring非必须通话结束时间
├─ recordstring非必须通话录音
├─ talkTimenumber非必须通话时长
├─ hangupBystring非必须挂断方
├─ numOfAgentHoldnumber非必须坐席保持次数
├─ numOfAgentSilencenumber非必须坐席静音次数
├─ numOfAgentToIvrnumber非必须坐席转IVR次数
├─ numOfAgentTransfernumber非必须坐席转接次数
├─ numOfAgentAdvisorynumber非必须坐席咨询次数
├─ numOfAgentThirdnumber非必须坐席三方次数
├─ agentEventsstring []非必须坐席通话中事件

item 类型: string

├─ 非必须坐席事件
├─ ivrInfoobject非必须通话IVR信息
├─ recordstring非必须ivr通话记录录音
├─ variablesstring []非必须通话记录变量集合

item 类型: string

├─ 非必须变量
├─ labelsstring []非必须通话记录标签集合

item 类型: string

├─ 非必须标签
├─ ivrTimesnumber非必须IVR停留时长
├─ processobject非必须IVR事件流程
├─ beginAtstring非必须ivr开始时间，时间格式：yyyy-MM-dd HH:mm:ss
├─ endAtstring非必须ivr结束时间，格式同上
├─ ivrNamestring非必须vr名称
├─ ivrLogstring非必须ivr日志
├─ phoneInfoobject非必须
├─ numberstring非必须号码
├─ provincestring非必须省份
├─ citystring非必须市
├─ operatorstring非必须运营商
├─ queueInfoobject非必须
├─ enterQueuenumber非必须入队节点
├─ enterRulestring非必须入队规则
├─ enterEventstring非必须入队事件
├─ repeatCusterRulestring非必须回头客规则
├─ queueTypestring非必须队列类型
├─ queueIdnumber非必须队列ID
├─ queueNamestring非必须队列名称
├─ customerLevelnumber非必须客户等级
├─ callLevelnumber非必须呼叫等级
├─ enterAtstring非必须入队时间
├─ queueTimenumber非必须排队时长
├─ assignAtstring非必须分配时间
├─ assignRulestring非必须分配规则
├─ continuousRingTimenumber非必须连续振铃时长
├─ lastAgentRingTimenumber非必须最后坐席振铃时长
├─ numOfSeqRingnumber非必须顺振次数
├─ seqRingEventstring非必须顺振事件
├─ queueResultstring非必须排队结果
├─ ringResultstring非必须振铃结果
├─ surveryListstring []非必须满意度调查信息

item 类型: string

├─ 非必须满意度调查详细数据
├─ messageUrlstring非必须留言
├─ adTaskNamestring非必须自动外呼任务名称
├─ externFlagstring非必须是否转外线
├─ validFlagstring非必须通话有效性，0-不做判断，1-有效，2-无效
├─ viewCallVariablesListstring []非必须IVR变量

item 类型: string

├─ 非必须
├─ allRecordUrlListobject []非必须全部录音

item 类型: object

├─ recordUrlstring非必须录音地址
├─ recordTypestring非必须类型
├─ totalIvrTimenumber非必须ivr总时长

10 添加限制号码

基本信息

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: 呼出

Query

参数名称 是否必须 示例 备注
pageNum 否 1 页码
pageSize 否 20 每页行数
keyword 否 1871018 关键词(号码），支持模糊查询

返回数据

名称类型是否必须默认值备注其他信息
succeedboolean必须成功标识
codenumber必须结果码
bizCodestring必须bizCode
messagestring必须消息
visibleboolean必须是否可见
pagingobject必须页码信息
├─ pageNumnumber必须页码
├─ pageSizenumber必须每页行数
├─ 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必须是否可见