华为云用户手册

响应说明 表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表示子业务结果）。

报文样例 该接口的响应消息体举例如下： { "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!"}

接口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 当前页码。 取值范围：正整数。

请求说明 表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存在且仅存在其一。

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

接口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。

报文样例 该接口的请求消息体举例如下： {"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"}

黑名单模板 请参考表1创建Excel模板文件。 表1 黑名单模板 黑名单号码（必填） 到期时间（非必填） 有效时长（非必填，单位：小时） 限制次数 限制周期 65676950 - - 1 1 88888888 2022-05-27 23:06:25 - - - 88888888 2022-06-24 10:06:25 - - - 12345678 2022-06-24 10:06:25 - - - 表2 黑名单模板参数说明 序号 参数名 参数类型 是否必选 说明 1 黑名单号码（必填） String True 号码最大长度为24个字符，有效字符为：0~9、*、# 2 到期时间（非必填） String False 到期时间，到期时间=新增时间点+有效时长。例：“2020-12-31 10:06:25”新增2条黑名单号码，有效时长120小时，则到期时间为“2021-01-05 10:06:25”。 3 有效时长（非必填，单位：小时） INT False 有效时长，单位小时，取值范围1~120。 4 限制次数 INT False 限制次数（与限制周期绑定，两者都填或都不填，范围：1-100） 5 限制周期 String False 限制周期（0：每小时；1：每天） 示例1："restrictTimes":1，"restrictPeriod":"0" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-30 11:00:00 示例2："restrictTimes":1，"restrictPeriod":"1" 表示2020-12-30 10:06:25 呼出一次，下次可呼出时间为2020-12-31 00:00:00

报文样例 该接口的请求消息体举例如下： {"serverId":"164690088271159234793429225848", "filePath":"/isales/upload", "fileName":"demoBlack.xlsx","hour":"11","minute":"00"} 该接口的响应消息体举例如下： {"returnCode": "0200000","importTaskId": "164757251098048478018607266946","resultCode": "0200000","resultDesc": "数据导入中，请通过“导入结果”查看详细信息。","returnDesc": "数据导入中，请通过“导入结果”查看详细信息。"}

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

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

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0, "importTaskIds":["164698362894300182038011895728"]} 该接口的响应消息体举例如下： {"result": [{"succNum": 0,"failNum": 0,"errMsg": "","id": "164698362894300182038011895728","beginTime": "2022-03-11T07:27:09.000+00:00","endTime": "2022-03-11T07:27:09.000+00:00","repeatNum": 0,"status": "2"}],"returnCode": "0200000","resultCode": "0200000","resultDesc": "success","returnDesc": "success"}

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。 取值范围：1～100

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 offset int True offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。 2 limit int True 表示每页的查询数量。 取值范围：1～100

报文样例 该接口的请求消息体举例如下： { "limit":10, "offset":0, "importTaskIds":["164698362894300182038011895728"]} 该接口的响应消息体举例如下： {"result": [{"succNum": 0,"failNum": 0,"errMsg": "","id": "164698362894300182038011895728","beginTime": "2022-03-11T07:27:09.000+00:00","endTime": "2022-03-11T07:27:09.000+00:00","repeatNum": 0,"status": "2"}],"returnCode": "0200000","resultCode": "0200000","resultDesc": "success","returnDesc": "success"}

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "countDetail": [ { "calledCount": 0, "batchDetail": [], "campaignId": "1798316116", "finishCount": 0, "unCallCount": 0, "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "batchDetail": [ { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "123456", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 }, { "calledCount": 0, "finishCount": 0, "unCallCount": 1, "batchId": "66666", "totalCount": 3, "totalCallSucc": 2, "totalCalledCount": 3, "totalFinishCount": 3, "dailyFinishCount": 3, "dailyCalledCount": 3, "dailyCallSucc": 2, "dailyCount": 3 } ], "campaignId": "1549589640", "finishCount": 0, "unCallCount": 3 } ]}

接口URI https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/statistics?campaignId={campaignId}&batchId={batchId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId String False 外呼数据ID 该参数有值，查询当前任务的全量和所有批次。 该参数为空时，查询所有任务的全量和所有批次。 3 batchId String False，该字段有值，则campaignId必传。 批次号，映射t_isl_data表customField字段。 该参数有值时，查询当前任务的全量和所传批次。

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 countDetail Array 返回每个任务的数量。 具体见表4 表4 countDetail结构 序号 参数名 参数类型 说明 1.1 campaignId String 外呼数据ID。 1.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.3 calledCount int 当天已拨打量。 1.4 finishCount int 已完成呼叫总量 1.5 batchDetail Array 返回每个customField(批次号)值的数量 具体见表 batchDetail结构。 1.6 totalCalledCount int 该活动已拨打总量 1.7 totalCallSucc int 该活动接通呼叫总量 1.8 totalFinishCount int 该活动已完成呼叫总量 1.9 totalCount int 该活动总呼叫量（含完成，呼叫中，未呼叫） 1.10 dailyCalledCount int 当天已拨打量 1.11 dailyCallSucc int 当天接通呼叫总量 1.12 dailyFinishCount int 当天已完成呼叫总量 1.13 dailyCount int 当天呼叫量（含完成，呼叫中，未呼叫） 表5 batchDetail结构 序号 参数名 参数类型 说明 1.5.1 batchId String 代表增加外呼数据时的批次id。 取值与customField一致。 1.5.2 unCallCount int 该活动ID下的剩余未拨打总量。 1.5.3 calledCount int 当天已拨打量。 1.5.4 finishCount int 已完成呼叫总量 1.5.5 totalCalledCount int 该活动已拨打总量 1.5.6 totalCallSucc int 该活动接通呼叫总量 1.5.7 totalFinishCount int 该活动已完成呼叫总量 1.5.8 totalCount int 该活动总呼叫量（含完成，呼叫中，未呼叫） 1.5.9 dailyCalledCount int 当天已拨打量 1.5.10 dailyCallSucc int 当天接通呼叫总量 1.5.11 dailyFinishCount int 当天已完成呼叫总量 1.5.12 dailyCount int 当天呼叫量（含完成，呼叫中，未呼叫）

外呼数据导入模板 请参考表1创建Excel模板文件。 表1 外呼数据模板 sessionId(非必填) called必填 caller(非必填) callData(非必填) customField（非必填） recycleTime(非必填) - [{'calledNo':1234566}] - - - - 表2 外呼数据模板参数说明 序号 参数名 参数类型 是否必选 说明 1.1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 1.2 called String True JSON数组 客户号码信息。 1.3 caller String False 主叫号码。 最大长度为24个字符。 1.4 customField String False 用户自定义字段，最大长度200。 1.5 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 1.6 callData String False 随路数据，最大长度1024，建议JSON格式。 注意： 当自动外呼涉及到智能IVR流程时，该参数格式只支持JSON格式。 智能IVR流程使用JSON格式调用图元对JSON格式的随路数据进行解析和赋值操作，图元的具体实现和使用方式请参见JSON数据调用图元。 JSON格式参考如下： {\\\"iSales\\\":{\\\"ServiceID\\\":\\\"1164541685\\\",\\\"fullName\\\":\\\"林子航\\\",\\\"date\\\":\\\"二零二二年三月三十一日\\\",\\\"riskName\\\":\\\"交强险\\\"}} 表3 called参数说明 序号 参数名 参数类型 是否必选 说明 1.2.1 calledNo String True 客户被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 1.2.2 delayTime String False 客户每个号码呼叫的间隔时间，单位秒，范围0~7200，默认值0。 1.2.3 type String False 客户号码类型。

报文样例 该接口的请求消息体举例如下： { "serverId":"164690088271159234793429225848", "filePath":"/isales/upload", "fileName":"demogl50w.xlsx"} 该接口的响应消息体举例如下： {{"returnCode": "0200000","importTaskId": "164870990605164487770867067540","resultCode": "0200000","resultDesc": "数据导入中，请通过“导入结果”查看详细信息。","returnDesc": "数据导入中，请通过“导入结果”查看详细信息。"}

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

报文样例 请求头: Content-Type:application/json;charset=UTF-8Authorization:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: {"callId" : "1653031709-1051528301180",} 响应参数: { "returnCode": "0200000", "recordList": [ { "interNo": "1", "userSaying": null, "systemReply": "啊您看我们请专门负责的同事和您简要介绍一下展会亮点您看可以吗只要和外贸相关的企业对于我们展会都会有兴趣的", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:10", "responseSource": "0" }, { "interNo": "2", "userSaying": "null", "systemReply": "您好，欢迎使用智能机器人", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:08", "responseSource": "0" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success"}

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 原因码。0200000表示成功，其他表示失败。 2 recordList List false 通话记录。 2.1 interNo string True 内部序号 2.2 systemReply string True 系统回复。 系统回复为IVR流程或智能IVR流程中的语音文件时，语音文件有杂音或为音乐将会无法准确转写为文本信息。 语音文件或TTS文本在通话过程中如果被打断无法播放完整，查询出来的系统回复也会是完整的语音文件内容。 2.3 userSaying string True 用户回复 2.4 intention string True 用户意图 2.5 systemReplyTime string True 系统回复时间 2.6 requestTime string True 用户请求时间 2.7 responseSource string True 回复来自机器人还是静默座席。 机器人--0，静默座席--1 3 resultDesc String true 返回描述信息 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

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

请求说明 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 2 Content-Type string True 固定填 application/json; charset=UTF-8。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId String true 通话记录ID，用于与CTI平台的话单等通话数据关联。

响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode String True 原因码。0200000表示成功，其他表示失败。 2 recordList List false 通话记录。 2.1 interNo string True 内部序号 2.2 systemReply string True 系统回复。 系统回复为IVR流程或智能IVR流程中的语音文件时，语音文件有杂音或为音乐将会无法准确转写为文本信息。 语音文件或TTS文本在通话过程中如果被打断无法播放完整，查询出来的系统回复也会是完整的语音文件内容。 2.3 userSaying string True 用户回复 2.4 intention string True 用户意图 2.5 systemReplyTime string True 系统回复时间 2.6 requestTime string True 用户请求时间 2.7 responseSource string True 回复来自机器人还是静默座席。 机器人--0，静默座席--1 3 resultDesc String true 返回描述信息 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

请求说明 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 Authorization string True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 2 Content-Type string True 固定填 application/json; charset=UTF-8。 表3 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId String true 通话记录ID，用于与CTI平台的话单等通话数据关联。 2 page int true page为需要查询的起始页。 取值范围：1～1000 3 limit int true 表示每页的查询数量。 取值范围：1～100

报文样例 请求头: Content-Type:application/json;charset=UTF-8Authorization:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: {"callId" : "1653031709-1051528301180", "page":1,"limit":10} 响应参数: { "returnCode": "0200000", "recordList": [ { "interNo": "1", "userSaying": null, "systemReply": "啊您看我们请专门负责的同事和您简要介绍一下展会亮点您看可以吗只要和外贸相关的企业对于我们展会都会有兴趣的", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:10", "responseSource": "0" }, { "interNo": "2", "userSaying": "null", "systemReply": "您好，欢迎使用智能机器人", "intention": null, "systemReplyTime": "2022-05-31 20:13:08", "requestTime": "2022-05-31 20:13:08", "responseSource": "0" } ], "resultCode": "0200000", "resultDesc": "success", "returnDesc": "success"}

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