华为云用户手册

接口URI https://ip:port/rest/isales/v1/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。

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 2 called String False 被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 3 customField String False 用户自定义字段，删除时可根据该字段批量删除，最大长度为200个字符。 4 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 5 recycleType String False 回收类型。只在传入recycleTime的同时传入，该参数有效。 取值范围： 1：删除早于传入的recycleTime（精确到天）的外呼号码。 例如，传入2020-12-04 17:57:00，会将指定外呼活动下，recycleTime在12月4日及以前的外呼号码都删除 2：删除传入的recycleTime当天的外呼号码。 例如，传入2020-12-04 17:57:00，会删除指定外呼活动下，recycleTime在2020-12-04 00:00:00到2020-12-04 23:59:59之间的外呼号码 3：删除与传入的recycleTime相等的外呼号码。 6 archiveHistory int False 是否移历史表。 取值范围：0，1。 0：不移历史表，直接删除。1：移入历史表。默认为0。

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/add 其中，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 callNoTypes List True 号码类型集合，最多20条。 最大长度为20个字符。 只能输入数字、英文、-。

报文样例 该接口的请求消息体举例如下： { "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 当前系统需要外呼的数据总数。

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callDataList List True 新增数据列表，最多20条。 该对象的参数说明请参见表4。 表4 callDataList参数说明 序号 参数名 参数类型 是否必选 说明 1.1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 1.2 called List True 客户号码信息。 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格式请参照如下，其中斜体部分可自定义，其余参数和格式请保持固定： "callData":"{\\\"fullName\\\":\\\"林子航\\\",\\\"date\\\":\\\"二零二二年三月三十一日\\\",\\\"riskName\\\":\\\"交强险\\\"}" 表5 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 客户号码类型。 新增外呼活动时，当“外呼结果策略”的策略类型配置为“号码分类匹配策略”，该参数必填。 新增外呼活动时，当“呼叫策略”的呼叫方式为“按轮次”，该参数必填。 填写时，内容自定义，取值范围：最大长度20字符，不包含特殊字符。

接口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下的被叫号码不能有重复。 每次追加的被叫号码中不能存在黑名单号码，或者被叫号码在黑名单号码中并为其配置了限制周期和限制次数（但外呼次数不能超过限制周期内的限制次数）。 已完成的任务不允许追加号码。

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

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 busiResult String True 业务结果编码，最大长度为50个字符。 2 subStatus String False 子业务状态编码，最大长度为50个字符。 3 busiResultDesc String False 业务结果描述。 4 workNo String False 执行呼叫的座席的平台工号。 如果需要同一个外呼数据，始终呼叫到同一个座席，该参数必填，如不填，则会路由至其他座席。

报文样例 该接口的请求消息体举例如下： { "busiResult": "1621474513", "subStatus": "1048856206", "busiResultDesc": "1", "workNo": "2033"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "The business result is written back successfully."}

报文样例 该接口的请求消息体举例如下： [ { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:00:00", "callStatus": 6, "failCode": "0", "vdnId": 11, "callId": "0023-134864174", "recordPath": "Y:/1/11/20200830/3408/0949218.V3" }] 该接口的响应消息体举例如下： { "retCode": "0", "retMsg": "success"}

请求说明 无请求头消息。 表1 请求消息体参数说明 序号 参数名 参数类型 说明 1 callResultList List 外呼结果列表，此处仅做说明，实际无此实体对象，response直接返回List。具体参考表2。 表2 callDataList参数说明 序号 参数名 参数类型 说明 1 campaignId String 外呼活动的id 2 sessionId String 标识用户的ID。 3 called String 被叫号码。 4 callTimeStr String 呼叫时间，格式为：yyyy-mm-dd hh:mm:ss。 5 callStatus int 呼叫结果（5: 呼叫失败，6: 呼叫成功）。 6 failCode String 失败的原因码，请参见表4。 7 vdnId int 外呼号码所属VDN ID。 8 callId String 通话记录ID，用于与CTI平台的话单等通话数据关联。 9 customField String 用户自定义字段。 10 recordPath String 通话录音文件的存储路径。 说明： 该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。

结果码 表4 外呼结果错误原因码说明 分类 错误原因码 错误原因描述 外呼成功 00000 外呼成功。 用户侧拆线 00531 外呼用户挂机。 00537 外呼号码被叫忙。 00538 外呼号码为空号或错号。 00548 外呼手机号码关机。 00549 外呼手机号码不在服务区。 00551 用户挂机。 00601 应答前用户挂机。 00603 外呼号码无应答后拆线。 00604 呼叫拒绝。 00701 外呼用户转队列，排队中用户主动挂机。 平台正常拆线 00702 外呼用户转队列，排队超时，平台释放呼叫（若配置为排队超时释放）。 01040 振铃超时，平台释放呼叫。（即在设置的振铃时间内，用户一直没有摘机） 01043 平台内部等待外呼结果超时。 01046 占用座席失败（转IVR外呼不涉及）。 01049 外呼检测超时。 34601 外呼任务不存在。 34605 电话号码为空，即外呼获取的被叫号码为空字符串。 34606 试呼失败，即调用呼出接口失败(比较常见的一种情况：当前的并发外呼数达到了最大外呼数；)，没有呼出到用户。 34608 呼出后，没有得到呼出结果信息，超时后将该呼叫数据回写。 系统资源不足，平台侧拆线 00602 系统资源不足，请联系管理员检查资源配置。 00605 01048 34606 系统异常 00606 请联系管理员排查。 34611 其他

报文样例 该接口的请求消息体举例如下： { "sessionId": "1202_test013", "pageSize": 500, "pageNum": 1} 该接口的响应消息体举例如下： { "resultCode":"0200000", "resultDesc":"Query Success!", "returnCode":"0200000", "returnDesc":"Query Success!", "totalCount": 2, "data": [ { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:00:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864174", "recordPath": "Y:/1/11/20200830/3408/0949218.V3" }, { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:05:00", "callStatus": 6, "failCode": "0", "resultCode": "OB99999", "vdnId": 11, "callId": "0023-134864893", "recordPath": "Y:/1/11/20200830/3408/0942113.V3" } ]}

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200007 外呼活动已经不存在。 3 0200008 开始时间和结束时间不是同时存在，或者同时不存在。 4 0200009 开始时间或者结束时间的格式不正确。 5 0200010 开始时间不是早于结束时间。 6 0200011 开始时间和结束时间相差的天数超过30天。

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

响应说明 表4 响应体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 4 returnDesc String 描述。 5 totalCount int 外呼结果总数 6 data JSONArray 结果json，详见表5。 表5 data参数说明 序号 参数名称 参数类型 描述 6.1 campaignId String 外呼任务的id 6.2 sessionId String 标识用户的ID 6.3 called String 被叫号码 6.4 callTimeStr String 呼叫时间，格式为：yyyy-mm-dd hh:mm:ss 6.5 callStatus int 呼叫结果（5: 呼叫失败, 6: 呼叫成功） 6.6 failCode String 失败的原因码。 6.7 resultCode String 失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联。 6.8 vdnId int 外呼号码所属VDN ID。 6.9 callId String 通话记录ID，用于与CTI平台的话单等通话数据关联。 6.10 recordPath String 通话录音文件的存储路径。 说明： 该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。

报文样例 该接口的请求消息体举例如下： {"name": "呼叫失败","code": "123456","description": "呼叫失败","children": [{"name": "客户直接挂断","code": "100001","description": "客户直接挂断"},{"name": "客户关机","code": "100002","description": "客户关机"}]} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "addBusinessResult success", "returnCode": "0200000", "returnDesc": "addBusinessResult success"}

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 name String True 业务结果名称。 取值范围：最大长度50，不包含特殊字符。 2 code String False 业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 3 description Sring False 业务结果描述。 取值范围：最大长度200，不包含特殊字符。 4 children List False 子业务结果。 该对象的参数说明请参见表4。 表4 children参数说明 序号 参数名 参数类型 是否必选 说明 4.1 name String True 子业务结果名称。 取值范围：最大长度50，不包含特殊字符。 4.2 code String False 子业务结果编码。 取值范围：最大长度50，有效字符为：数字、字母、-。 4.3 description String False 子业务结果描述。 取值范围：最大长度200，不包含特殊字符。

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

报文样例 该接口的请求消息体举例如下： { "name": "test0827shwocase1", "description": "long0825", "strBeginTime": "2021-08-27 00:00:00", "strEndTime": "2021-08-28 23:59:59", "deviceType": 2, "callerNo": [ { "accessCode": "88889527", "priority": 3 }, { "accessCode": "88880066", "priority": 4 } ], "maxAlertingTime": 20, "priority": 4, "scheduleParam": { "workdayBeginTime1": "00:00", "workdayEndTime1": "23:59", "workdayBeginTime2": "", "workdayEndTime2": "", "workdayBeginTime3": "", "workdayEndTime3": "", "holidayBeginTime1": "10:00", "holidayEndTime1": "11:00", "holidayBeginTime2": "13:00", "holidayEndTime2": "17:30", "holidayBeginTime3": "", "holidayEndTime3": "" }, "skillParam": { "skillId": 2, "skillName": "defaultAudioSkill", "outBoundType": 2, "predictParam": { "predictMethod": 1, "expPredictParam": { "maxAvgCallTime": 100, "minAvgCallTime": 50, "outBoundRate": 50 } } }, "retryPolicy": { "policyType": 1, "policyJson": "[{'dataType':'SI','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':600}]}]" }, "callPolicy": { "callType": 1, "chooseType": 0, "turns": [ { "turnType": "SI" } ] }, "initStatus": 0, "callBackUrl": "https://10.10.10.10/xxx/xxx/xxx"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 46 }}

错误结果码 表23 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200002 外呼活动的开始时间早于今天凌晨。 3 0200003 设备类型为技能队列的外呼活动已达到上限。如果需要继续新增，则先删除其他设备类型为技能队列的外呼活动。 4 0200004 设备类型为IVR的外呼活动已达到上限。如果需要继续新增，则先删除其他设备类型为IVR的外呼活动。 5 0200005 外呼活动名称不能重复。 6 0200017 技能队列ID不存在。

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

报文样例 该接口的请求消息体举例如下： {"name": "test0827shwocase1","description": "long0825","strBeginTime": "2021-08-27 00:00:00","strEndTime": "2021-08-28 23:59:59","deviceType": 2,"callerNo": [{"accessCode": "88889527","priority": 3}],"maxAlertingTime": 20,"priority": 4,"scheduleParam": {"workdayBeginTime1": "00:00","workdayEndTime1": "23:59","workdayBeginTime2": "","workdayEndTime2": "","workdayBeginTime3": "","workdayEndTime3": "","holidayBeginTime1": "","holidayEndTime1": "","holidayBeginTime2": "","holidayEndTime2": """holidayBeginTime3": "","holidayEndTime3": ""},"skillParam": {"skillId": 2,"skillName": "defaultAudioSkill","outBoundType": 2,"predictParam": {"predictMethod": 1,"expPredictParam": {"maxAvgCallTime": 100,"minAvgCallTime": 50,"outBoundRate": 50}}},"retryPolicy": {"retryPolicyId": "163005925789859991571901887599","policyType": 1,"policyJson": "[{'dataType':'SI','type':1,'policy':[{'result':2,'retryNumber':4,'callInterval':600}]}]","busiPolicy": "[{'busiResultCode':'14376596','busiResultSubCode':'14963248','busiResultPolicy':1,'callInterval':300}]"},"callPolicy": {"callPolicyId": "163005925791583092505770074569","callType": 1,"chooseType": 0,"turns": [{"turnType": "SI"}]},"initStatus": 0,"callBackUrl": "https://10.10.10.10/xxx/xxx/xxx"} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": ""}

接口URI https://ip:port/rest/isales/v2/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。