华为云用户手册

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "curPage": 1, "totalSize": 3, "rowsPerPage": 10, "data": [ { "id": 3, "name": "666", "status": 1, "strBeginTime": "2018-11-30 16:00:47", "strEndTime": "2018-11-30 3:01:12", "deviceType": 2, "callerNo": "10080" }, { "id": 4, "name": "666333696", "status": 1, "strBeginTime": "2018-11-30 16:11:36", "strEndTime": "2018-11-30 23:11:43", "deviceType": 2, "callerNo": "10080" }, { "id": 2, "name": "SAAS_JST", "status": 3, "strBeginTime": "2018-11-29 15:54:44", "strEndTime": "2018-12-08 15:54:45", "deviceType": 2, "callerNo": "10080" } ], "curSkillQueueCount": 3, "curIvrCount": 0}

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 name String False 外呼活动的名称。 长度为0~30，默认值为空。 3 status int True 外呼活动的状态。 取值范围： 2：已开始 3：暂停 4：已完成 输入值为0时默认查询全部状态。 4 deviceType int True 外呼设备类型。 取值范围： 2：预测外呼的技能队列 3：自动外呼的IVR 5：预览外呼的技能队列 6：预占外呼的技能队列 输入值为0时默认查询全部类型。 5 beginTime String False 外呼活动的最小开始时间，格式为yyyy-MM-dd HH:mm:ss。 6 endTime String False 外呼活动的最大结束时间，格式为yyyy-MM-dd HH:mm:ss。 7 curPage int True 当前第几页。 默认值为1，输入值小于1时自动修正为1。 8 rowsPerPage int True 每页记录数。 该值不输入的时候，默认查询10条，且最大值为100。 9 ccId int False 传了就按指定的ccid过滤，不传就不过滤

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5 4 returnDesc String 描述。 5 curPage int 当前页。 6 totalSize int 总记录数。 7 rowsPerPage int 每页记录数。 8 curSkillQueueCount int 当前技能队列外呼活动总数。 9 curIvrCount int 当前IVR外呼活动总数。 10 data List 查询成功后，返回外呼活动信息的对象(Campaign)。 参见表4

报文样例 该接口的请求消息体举例如下： 可以根据业务需要选择不同的策略组合。 全局策略+普通策略policyType=0，type=0。 {"policyJson":"[{'type':0,'retryTimes':1,'retryDay':1}]","policyType": 0} 全局策略+结果策略policyType=0，type=1。 {"policyJson":"[{'type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]","policyType": 0} 号码类型匹配策略+普通策略policyType=1，type=0。 {"policyJson" : "[{'dataType':'ST','type':0,''policy':{'retryTimes':2,'retryDay':1}}]","policyType": 1} 号码类型匹配策略+结果策略policyType=1，type=1。 {"policyJson":"[{'dataType':'ST','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]","policyType": 1} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": ""}

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

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": { "retryPolicyId": "1871694313", "policyType": 0, "policyJson": "[{'retryTimes':1,'retryDay':2,'type':0,'policy':[]}]" }, "returnDesc": null}

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

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表7。 2 resultDesc String 描述。 3 data Object 外呼重试策略。具体参见表4。 表4 data参数说明 序号 参数名 参数类型 说明 3.1 retryPolicyId String 重试策略ID。 3.2 policyType int 重试策略类型： 0为全局策略 1为号码分类策略 3.3 policyJson String 重试策略参数。具体见表5 表5 policyJson参数说明 序号 参数名 参数类型 说明 3.3.1 dataType String 号码类型。 3.3.2 policy String 按照结果匹配的策略json串。 该对象的参数说明请参见表 policy参数说明 3.3.3 retryDay int 普通策略，试呼天数。 3.3.4 retryTimes type int int 普通策略，每天试呼次数。 重试逻辑策略类型： 0：普通策略 1：结果策略 3.3.5 noRetryPolicy String 不重试的结果码。即配置不重试的结果码，该结果码来源于“查询外呼结果定义列表”中的“data”属性下的“resultCode”字段。 表6 policy参数说明 序号 参数名 参数类型 说明 3.3.2.1 callInterval int 延迟时间。 3.3.2.2 result int 结果类型。 3.3.2.3 retryNumber int 重试次数。

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

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表21 4 returnDesc String 描述。 5 returnObject Object 参见表4

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 146, "name": "lizhan_test", "description": null, "status": 2, "strBeginTime": "2018-12-01 00:25:49", "strEndTime": "2018-12-02 00:25:52", "deviceType": 2, "callerNo": "10086", "maxAlertingTime": 20, "scheduleParam": { "workdayBeginTime1": "08:00", "workdayEndTime1": "12:00", "workdayBeginTime2": "13:30", "workdayEndTime2": "17:30", "workdayBeginTime3": null, "workdayEndTime3": null, "holidayBeginTime1": "09:00", "holidayEndTime1": "12:00", "holidayBeginTime2": "14:00", "holidayEndTime2": "17:00", "holidayBeginTime3": null, "holidayEndTime3": null }, "ivrParam": null, "skillParam": { "skillId": 1, "skillName": "Voice Skill Queue", "outBoundType": 2, "predictParam": { "predictMethod": 5, "expPredictParam": null, "agentPredictParam": null, "connectPredictParam": null, "offhookPredictParam": { "offHookRate": 100 } }, "previewParam": null }, "callBackUrl": "http://www.baidu.com" }}

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 name String True 节假日名称。 名称不能重复，最大长度为30个字符。 2 type int True 节假日的类型。 取值范围： 1：按周设置 2：按日期设置 3：按日期重复 3 week String False 星期，节假日的类型为按周设置时为True。 取值范围： 1：星期一 2：星期二 3：星期三 4：星期四 5：星期五 6：星期六 7：星期天 同时选择多天时以逗号分隔，例如“6,7”表示星期六、星期天 4 beginTime String False 开始时间，节假日的类型为按日期设置或按日期重复时为True。 节假日的类型为2时，数据格式：yyyy-MM-dd 节假日的类型为3时，数据格式：MM-dd 5 endTime String False 结束时间，节假日的类型为按日期设置或按日期重复时为True。 节假日的类型为2时，数据格式：yyyy-MM-dd 节假日的类型为3时，数据格式：MM-dd

报文样例 该接口的请求消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnObject": { "id": 1318795089 }} 该接口的响应消息体举例如下： { "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24"}

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

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

报文样例 该接口的请求消息体举例如下： { "id": 1318795089, "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": ""}

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 id int True 节假日的id。 2 name String True 节假日名称。 名称不能重复，最大长度为30个字符。 3 type int True 节假日的类型。 取值范围： 1：按周设置 2：按日期设置 3：按日期重复 4 week String False 星期，节假日的类型为按周设置时为True。 取值范围： 1：星期一 2：星期二 3：星期三 4：星期四 5：星期五 6：星期六 7：星期天 同时选择多天时以逗号分隔，例如“6,7”表示星期六、星期天 5 beginTime String False 开始时间，节假日的类型为按日期设置或按日期重复时为True。 节假日的类型为2时，数据格式：yyyy-MM-dd 节假日的类型为3时，数据格式：MM-dd 6 endTime String False 结束时间，节假日的类型为按日期设置或按日期重复时为True。 节假日的类型为2时，数据格式：yyyy-MM-dd 节假日的类型为3时，数据格式：MM-dd

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

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

报文样例 该接口的请求消息体举例如下： { "blocklist": [ "13100000000", "13100000001", "13100000002", "13100000003" ], "validityExpirationTime":"2020-12-31 10:06:25", "restrictTimes":3, "restrictPeriod":"0"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "The blocklist is added successfully"}

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

使用说明 前提条件 已经申请了开发者账号。 使用限制 黑名单号码最大长度为24个字符。 黑名单号码有效字符为：0~9、*、#。 每次只能增加20条黑名单号码，否则提示“超过单次新增最大数量”，且不新增黑名单号码。 每次追加的黑名单号码不能有重复，否则提示“号码重复”，且不新增黑名单号码。 每次追加的黑名单号码中不能存在已有黑名单号码。 当同时传入有效时长和到期时间时，则以指定时间（validityexpirationtime）为准处理。 限制次数小于重试策略设置的试呼次数。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklist List True 新增黑名单号码列表，最多20条。 号码最大长度为24个字符，有效字符为：0~9、*、# 2 validityExpirationTime String False 到期时间，到期时间=新增时间点+有效时长。例：“2020-12-31 10:06:25”新增2条黑名单号码，有效时长120小时，则到期时间为“2021-01-05 10:06:25”。 3 validityTime INT False 有效时长，单位小时，取值范围1~120。 4 restrictTimes INT False 限制次数（与限制周期绑定，两者都填或都不填，范围：1-100） 5 restrictPeriod 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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 blocklistNo String True 需要删除的黑名单号码。最大长度为24个字符，有效字符为：0~9、*、#

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

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

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

错误结果码 表7 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200018 存在重复的号码。 5 0200019 当前状态不允许追加号码。 6 0200020 号码数量超过了最大规格20w条。 7 0200022 接口调用太快。 8 0200024 添加的号码中存在黑名单号码。 9 0200029 超过了每次添加允许的最大值。 10 0200030 时间格式不正确。

报文样例 该接口的请求消息体举例如下： { "callDataList": [ { "sessionId": "00750", "called": "80021" }, { "sessionId": "00850", "called": "80022" }, { "sessionId": "00950", "called": "80023" }, { "sessionId": "01050", "called": "80024" } ]} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "totalSize": 46 }}

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callDataList List True 新增数据列表，最多20条。 该对象的参数说明请参见表 callDataList参数说明。 表4 callDataList参数说明 序号 参数名 参数类型 是否必选 说明 1.1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 1.2 called String True 被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 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。 注意： 当自动外呼涉及到智能IVR流程时，该参数格式只支持JSON格式。 智能IVR流程使用JSON格式调用图元对JSON格式的随路数据进行解析和赋值操作，图元的具体实现和使用方式请参见JSON数据调用图元。 JSON格式请参照如下，其中斜体部分可自定义，其余参数和格式请保持固定： "callData":"{\\\"fullName\\\":\\\"林子航\\\",\\\"date\\\":\\\"二零二二年三月三十一日\\\",\\\"riskName\\\":\\\"交强险\\\"}"