华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围：1～65535 2 vdn int True 虚拟呼叫中心编号。 取值范围：1～5000 3 agentIds array True 座席工号的数组，数组最大长度为3000。 取值范围：101-59999

报文样例 场景描述：样例报文 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 Content-Type:application/json 请求参数: { "caller": "8888888", "called": "6666614" } 响应参数: { "retMsg": "Called is not configured", "retCode": "5" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 被叫号码 长度限制:string(32) 1 caller string True 主叫号码 长度限制:string(32)

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 4：获取不到被叫标示 5：被叫未配置标示 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 devType number False 设备类型: 0：技能队列； 1：号码 长度限制：number (4) 1.3.2 called string False 被叫号码 长度限制:string(32) 1.3.3 skillId number False 技能队列 长度限制：number (16) 1.3.4 skillName string False 技能队列名称 长度限制：string(100) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见错误结果码。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见错误结果码。 4 returnDesc String 描述。 5 data Object 参见表5。 表5 data参数说明 序号 参数名 参数类型 说明 5.1 validityExpirationTime String 到期时间 5.2 blockNum String 黑名单号码 5.3 flag Boolean 黑名单有效标识，true：有效；false：无效 须知： 入参传入了blocklist才会返回该参数

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常，请检查请求参数 11 02000009 参数组合不正确，请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： {"limit":10,"offset":0} 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "validityExpirationTime": "2022-02-18T17:56:14.000+00:00", "blockNum": "111" }, { "validityExpirationTime": "2022-02-23T09:10:07.000+00:00", "blockNum": "34234" }, { "validityExpirationTime": "2022-02-23T09:11:13.000+00:00", "blockNum": "321" }, { "validityExpirationTime": "2022-03-03T02:01:40.000+00:00", "blockNum": "321" } ], "resultCode": "0200000", "resultDesc": "query BlockList Success", "returnDesc": "query BlockList Success" }

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/query 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklist List False 查询黑名单号码列表，最多20条。 号码最大长度为24个字符，有效字符为：0~9、*、# 注意： 如果传了该字段，则响应只返回该列表的黑名单号码，即响应结果为请求传入的黑名单列表是否在黑名单中，如果在，则返回黑名单号码相关信息，如到期时间、有效时长。 2 offset int False offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 3 limit int False 表示每页的查询数量。 取值范围：1～100 注意： limit offset和blocklist存在且仅存在其一。

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/deleteObsResult 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 defId String True 需要删除的外显结果ID

错误结果码 表4 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 02000001 参数值为空 3 02000002 参数包含非法字符 4 02000003 参数长度不能大于规定长度 5 02000004 参数长度不能小于规定长度 6 02000005 参数长度需要介于规定长度之间 7 02000006 参数值类型不正确 8 02000007 参数值大小不正确 9 02000008 参数转换异常，请检查请求参数 10 02000009 参数组合不正确，请检查请求参数 11 02000010 hour和minute必须同时存在 12 02000011 参数个数不能大于规定个数

请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 version True String（1-32） 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 是否必选 参数类型 默认值 说明 1 agentOprInfoFileName True String（1-49） 无 座席操作详单索引文件名称，已调用“生成座席操作详单索引”获取。 格式：yyyyMMdd_{responseId}.zip。 例如：已调用“生成座席操作详单索引”接口，调用“生成座席操作详单索引”接口的日期为2018-07-02，获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944，则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。

响应说明 当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成话单文件，文件后缀名为.zip，文件中各参数定义参考话单录音索引文件定义，响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表4，resultData为保留字段，默认为空字符串。 表4 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表5 不推荐使用，为兼容老版本保留字段。 表5 响应消息response参数说明 序号 名称 参数类型 说明 4.1 version String（1-32） 协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

报文样例 请求头 POST /CCFS/resource/ccfs/downloadAgentOprInfoFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host /ae066c2f5de******************afc161cb7e66f5d Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "agentOprInfoFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }

报文样例 场景描述：创建外呼任务 请求头： { "X-APP-Key": "b*************c7b", "Authorization": "Bearer 1fea*************1d6a15", "Content-Type": "application/json" } 请求参数 无。 响应参数： { "satisfactionSurvey": { "surveyType": "WEB", "satisfactionLevel": [ { "satisfactionLevelDesc": "很不满意", "satisfactionLevelKey": "1" }, { "satisfactionLevelDesc": "不满意", "satisfactionLevelKey": "2" }, { "satisfactionLevelDesc": "一般", "satisfactionLevelKey": "3" }, { "satisfactionLevelDesc": "满意", "satisfactionLevelKey": "4" }, { "satisfactionLevelDesc": "很满意", "satisfactionLevelKey": "5" } ] }, "resultCode": "0", "resultDesc": "Get satisfaction survey mode success!" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string True appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 3 ccmessaging-token string True applyToken接口生成的ccmessagign-token

报文样例 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": [ { "code": "11111", "children": [ { "code": "12324", "name": "sub02", "defLevel": "2" }, { "code": "1232", "name": "sub01", "defLevel": "2" } ], "name": "test111", "defLevel": "1" }, { "code": "test", "children": [], "name": "test0903", "defLevel": "1" }, { "code": "15105671", "children": [ { "code": "754646", "name": "通话中断", "defLevel": "2" }, { "code": "ob-12", "name": "多个地方官", "defLevel": "2" } ], "name": "失败4up", "defLevel": "1" } ], "resultCode": "0200000", "resultDesc": "queryBusinessResults Success!", "totalCount": 3, "returnDesc": "queryBusinessResults Success!" }

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200005 参数异常，异常详情在resultDesc中描述。 3 0200007 参数异常，异常详情在resultDesc中描述。 4 02000001 参数值为空 5 02000002 参数包含非法字符 6 02000003 参数长度不能大于规定长度 7 02000004 参数长度不能小于规定长度 8 02000005 参数长度需要介于规定长度之间 9 02000006 参数值类型不正确 10 02000007 参数值大小不正确 11 02000008 参数转换异常，请检查请求参数 12 02000009 参数组合不正确，请检查请求参数 13 02000010 hour和minute必须同时存在 14 02000011 参数个数不能大于规定个数

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6。 4 returnDesc String 描述。 5 data JSONArray 结果json，详见表4。 6 totalCount Long 返回列表中结果总条数。 表4 data参数说明 序号 参数名 参数类型 说明 5.1 name String 业务结果名称。 5.2 code String 业务结果编码。 5.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。 5.4 children List 子业务结果。 该对象的参数说明请参见表5。 表5 children参数说明 序号 参数名 参数类型 说明 5.4.1 name String 子业务结果名称。 5.4.2 code String 子业务结果编码。 5.4.3 defLevel String 业务结果层次（1表示父业务结果，2表示子业务结果）。

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryBusinessResults?pageSize={pageSize}&pageNum={pageNum} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 pageSize int True 分页查询结果，每页查询数据条数 取值范围：1-50。 3 pageNum int True 当前页码。 取值范围：正整数。

请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 channel string True 接收者渠道类型（WEB） 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口生成的ccmessagign-token 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 响应结果码 1.2 resultDesc string 响应结果描述。 如果resultCode返回0：Call in queue或Call connected或Call disconnected或Call queued timeout或Call failed或Call continue to poll events with unknown events或ClickToCall polled without any events 1.3 eventId string 事件编号 1.4 content object 事件内容 1.4.1 causeDesc string 原因描述 1.4.2 causeId string 原因 id 1.4.3 accessCode string 点击通话被叫 1.4.4 domain string WebRTC Gateway域名 1.4.5 gwAddresses array WebRTC Gateway通信地址和端口 1.4.6 clickToCallCaller string 点击通话主叫 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: ccmessaging-token: x-app-key: Authorization: 请求参数: 无 响应参数: { resultCode: "0", resultDesc: "Call connected", "eventId": 168101, "content": { "domain": "xxx", "gwAddresses": ["xx1", "xx2"], "accessCode": "179080000537636", "clickToCallCaller": "AnonymousCard" } }

错误结果码 表8 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200018 存在重复的号码。 5 0200019 当前状态不允许追加号码。 6 0200020 号码数量超过了最大规格20w条。 7 0200022 接口调用太快。 8 0200024 添加的号码中存在黑名单号码。 9 0200029 超过了每次添加允许的最大值。 10 0200030 时间格式不正确。 11 02000001 参数值为空 12 02000002 参数包含非法字符 13 02000003 参数长度不能大于规定长度 14 02000004 参数长度不能小于规定长度 15 02000005 参数长度需要介于规定长度之间 16 02000006 参数值类型不正确 17 02000007 参数值大小不正确 18 02000008 参数转换异常，请检查请求参数 19 02000009 参数组合不正确，请检查请求参数 20 02000010 hour和minute必须同时存在 21 02000011 参数个数不能大于规定个数

报文样例 该接口的请求消息体举例如下： { "callDataList": [ { "sessionId": "00750", "called": [ {"calledNo":"88880088","delayTime":"0","type":"ST"}, {"calledNo":"88880089","delayTime":"1","type":"SA"} ] }, { "sessionId": "00850", "called": [ {"calledNo":"88880080","delayTime":"0","type":"ST"} ] } ] } 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "totalSize": 46 } }

响应说明 表6 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 4 returnDesc String 描述。 5 returnObject Object 参见表7。 表7 returnObject参数说明 序号 参数名 参数类型 说明 5.1 totalSize int 当前系统需要外呼的数据总数。

接口URI https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/calldata/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

使用说明 前提条件 已经申请了开发者账号。 外呼活动已经创建。 使用限制 外呼活动未完成的外呼记录数不超过20W。 同一个外呼任务，默认每次增加20条，修改配置参数isales.api.calldata.max可调整每次添加的值，且前后接口调用时间不能小于1秒。建议不超过2000，且配置参数isales.api.uncomplate.count设置为false，否则接口调用可能会超过1S。 每次追加的同一个sessionId下的被叫号码不能有重复。 每次追加的被叫号码中不能存在黑名单号码，或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数（但外呼次数不能超过限制周期内的限制次数）。 已完成的任务不允许追加号码。 执行中的任务不允许新增外呼号码。

报文样例 请求头 Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数 { "ccId":1, "vdn":170, "callerNo": "12345", "calleeNo": "23131", "beginDate": "14511111111", "endDate": "14522222222", "isCallIn":"true" "limit": 10, "offset": 0 } 响应头 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT 响应参数 { "resultCode":"0100000", "resultDesc":{ "data":[ { "logDate": "1615717765000", // 统计时间 "callerNo": "1212", // 主叫号码 "calleeNo": "12121212",// 被叫号码 "callId": "167789709-33", // 呼叫标识 "callType": "1",// 呼叫类型 "waitBegin": "1615717765000",// 呼叫等待开始时间 "ackBegin": "1615717765000",// 呼叫应答时间 "callBegin": "1615717765000",// 通话开始时间 "callEnd": "1615717765000",// 通话结束时间 "vdn": 170, // vdn编号 "leaveReason": "1"， // 呼叫离开设备原因 "mediaType":53, // 媒体类型 "subMediaType":1 // 子媒体类型 } ], count: 5 } }

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/deleteServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 serverId string True 文件服务器ID