# 查询外呼活动详情 #### 前置条件 - 已经申请了开发者账号。 - 外呼活动已建立。 #### 场景描述 调用该接口查询指定外呼活动的详细配置。 #### 接口方法 该接口仅支持GET方法。 #### 接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1URL中携带的参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 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 监控/系统外呼/话单/知识库类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0003.html#ZH-CN_TOPIC_0000002481273406)。 | | 3 | locale | String | False | i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 | 无请求消息体。 #### 响应说明 表3消息体参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | resultCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表27] | | 2 | resultDesc | String | 描述。 | | 3 | returnCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表27] | | 4 | returnDesc | String | 描述。 | | 5 | returnObject | Object | 参见[表4] | 表4returnObject参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | id | String | 外呼活动id | | 2 | name | String | 外呼活动的名称。 | | 3 | description | String | 外呼活动的描述。 | | 4 | status | int | 外呼活动的状态编码。 取值范围： 1：草稿 2：执行中、呼叫完成、未开始 3：暂停 4：已过期 | | 5 | statusV2 | int | 与前台页面一致的外呼活动状态名称。 取值范围： 草稿 执行中 暂停 已过期 呼叫完成 未开始 | | 6 | statusCodeV2 | int | 与前台页面一致的外呼活动状态编码。 取值范围： 1：草稿 2：执行中 3：暂停 4：已过期 7：呼叫完成 8：未开始 | | 7 | strBeginTime | String | 外呼活动开始时间。格式说明：yyyy-MM-dd HH:mm:ss。UTC时间，不能早于今天 | | 8 | strEndTime | String | 外呼活动结束时间。格式说明：yyyy-MM-dd HH:mm:ss。UTC时间。 | | 9 | deviceType | int | 外呼设备类型。 取值范围： - 1：智能外呼的IVR（SaaS环境下且智能化特性开启时可用 ） - 2：预测外呼的技能队列 - 3：自动外呼的IVR - 5：预览外呼的技能队列 - 6：预占外呼的技能队列 | | 10 | callerNo | String | 主叫号码。 呼通客户后，客户的电话终端上显示的号码。 | | 11 | maxAlertingTime | int | 用户不应答最大振铃时长，超过该时长，则释放呼叫。 | | 12 | priority | int | 优先级 | | 13 | scheduleParam | Object | 呼出时间段。 该对象的参数说明请参见[表5]。 | | 14 | ivrParam | Object | deviceType为1，3（IVR）时非空。 该对象的参数说明请参见[表7]。 | | 15 | skillParam | Object | deviceType为2，5，6（技能队列）时非空。 该对象的参数说明请参见[表8]。 | | 16 | callBackUrl | String | 外呼结果的回调通知地址。 | | 17 | retryPolicy | Object | 外呼结果策略。 该对象的参数说明请参见[表15]。 | | 18 | callPolicy | Object | 呼叫策略。 该对象的参数说明请参见[表17]。 | | 19 | dataPolicy | Object | 外呼数据策略对象。 该对象的参数说明请参见[表4](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0722.html#ZH-CN_TOPIC_0000002513233727__zh-cn_topic_0000002480110548_zh-cn_topic_0000001150000332_table182103810165) | | 20 | blocklistParam | Object | 黑名单相关参数，详情见[表22]。 | | 21 | callRuleParam | Array | 设置呼叫规则，详情见[表23]。 | | 22 | callerNoDatas | List | 主叫号码组，详情见[表25] | 表5scheduleParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | workdayBeginTime1 | String | 工作日呼出时间段1开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 2 | workdayEndTime1 | String | 工作日呼出时间段1结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 3 | workdayBeginTime2 | String | 工作日呼出时间段2开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 4 | workdayEndTime2 | String | 工作日呼出时间段2结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 5 | workdayBeginTime3 | String | 工作日呼出时间段3开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 6 | workdayEndTime3 | String | 工作日呼出时间段3结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 7 | holidayBeginTime1 | String | 特殊日期呼出时间段1开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 8 | holidayEndTime1 | String | 特殊日期呼出时间段1结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 9 | holidayBeginTime2 | String | 特殊日期呼出时间段2开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 10 | holidayEndTime2 | String | 特殊日期呼出时间段2结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 11 | holidayBeginTime3 | String | 特殊日期呼出时间段3开始时间，格式为HH:mm。使用租户对应的时区时间。 | | 12 | holidayEndTime3 | String | 特殊日期呼出时间段3结束时间，格式为HH:mm。使用租户对应的时区时间。 | | 13 | holidayIdList | Array\ | 特殊日期id列表。详情见[表6]。 | 表6holidayIdList参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | holidayId | int | True | 已定义的节假期id，如果所有节假日的可呼叫时间一致，可通过设置活动中的holidayBeginTime1、holidayEndTime1参数。 | | 2 | beginTime1 | String | False | 可呼叫开始时间1，格式HH:MM | | 3 | endTime1 | String | False | 可呼叫结束时间1，格式HH:MM | | 4 | beginTime2 | String | False | 可呼叫开始时间2，格式HH:MM | | 5 | endTime2 | String | False | 可呼叫结束时间2，格式HH:MM | | 6 | beginTime3 | String | False | 可呼叫开始时间3，格式HH:MM | | 7 | endTime3 | String | False | 可呼叫结束时间3，格式HH:MM | 表7ivrParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.10.1 | deviceSign | String | IVR主流程接入码。 | | 5.10.2 | callCount | int | 外呼任务每次呼出的数量。 | | 5.10.3 | callInterval | int | 外呼任务的呼出间隔时间，单位秒。 | 表8skillParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.1 | skillId | int | 技能队列的ID。 | | 5.11.2 | skillName | String | 技能队列的名称。 | | 5.11.3 | outBoundType | String | 呼出方式， 取值范围： - 2：预测外呼 - 5：预览外呼 - 6：预占外呼 | | 5.11.4 | predictParam | Object | outBoundType为2时为True，预测呼出时的参数配置。 该对象的参数说明请参见[表10]。 | | 5.11.5 | previewParam | Object | outBoundType为5时为True，预览呼出时的参数配置。 该对象的参数说明请参见[表9]。 | 表9previewParam参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | failInterval | int | True | 呼出间隔时间，正整数，单位秒。 | | 2 | obCallCount | int | True | 每次呼出数量，正整数。 | | 3 | autoCallTime | int | True | 预览自动呼叫时长，正整数，单位秒。 | | 4 | skipMode | Array\ | False | 跳过模式： 0：不允许跳过。 1：临时跳过（只跳过本次呼叫，如果任务设置了重试策略，到重试时间地点之后会再次呼叫）。 2：永久跳过（无论任务是否设置了重试，永久跳过后不会再呼叫此客户），此参数可设置为不允许跳过，不传值时系统默认为不允许跳过，如果允许跳过，可设置两种跳过方式，临时跳过或永久跳过。 | 表10predictParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.4.1 | predictMethod | int | 预测外呼算法。 取值范围： 1：经验预测算法 2：座席利用率预测算法 3：外呼接通率预测算法 5：摘机率预测算法 | | 5.11.4.2 | expPredictParam | Object | 经验预测算法的参数配置，predictMethod为1（经验预测算法）时，非空。 该对象的参数说明请参见[表11]。 | | 5.11.4.3 | agentPredictParam | Object | 座席利用率预测算法的参数配置，predictMethod为2（座席利用率预测算法）时，非空。 该对象的参数说明请参见[表12]。 | | 5.11.4.4 | connectPredictParam | Object | 外呼接通率预测算法的参数配置，predictMethod为3（外呼接通率预测算法）时，非空。 该对象的参数说明请参见[表13]。 | | 5.11.4.5 | offhookPredictParam | Object | 摘机率预测算法的参数配置，predictMethod为5（摘机率预测算法）时，非空。 该对象的参数说明请参见[表14]。 | 表11expPredictParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.4.2.1 | maxAvgCallTime | int | 最大平均通话时长，单位秒。 | | 5.11.4.2.2 | mimAvgCallTime | int | 最小平均通话时长，单位秒。 | | 5.11.4.2.3 | outBoundRate | int | 呼出速率。 | 表12agentPredictParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.4.3.1 | maxAvgCallTime | int | 最大平均通话时长，单位秒。 | | 5.11.4.3.2 | mimAvgCallTime | int | 最小平均通话时长，单位秒。 | | 5.11.4.3.3 | lossRate | int | 最低呼损率。 | | 5.11.4.3.4 | utilRate | int | 座席利用率。 | | 5.11.4.3.5 | utilRateMethod | int | 座席利用率算法。 取值范围： 1：表示座席利用率＝总的通话时长/总的签入时长 2：表示座席利用率＝(总的通话时长＋工作态时长)/总的签入时长 | 表13connectPredictParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.4.4.1 | maxAvgCallTime | int | 最大平均通话时长，单位秒。 | | 5.11.4.4.2 | mimAvgCallTime | int | 最小平均通话时长，单位秒。 | | 5.11.4.4.3 | lossRate | int | 最低呼损率。 | | 5.11.4.4.4 | waitTime | int | 用户等待时间，单位秒。 | | 5.11.4.4.5 | connRate | int | 外呼接通率。 | 表14offhookPredictParam参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.11.4.5.1 | offHookRate | int | 摘机率。 | 表15retryPolicy参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.13.1 | retryPolicyId | String | 重试策略ID。 | | 5.13.2 | policyType | int | 重试策略类型。 0：全局策略 1：号码类型匹配策略。 | | 5.13.3 | retryDay | int | 最大试呼天数。若号码外呼未成功，允许在后续连续多个自然日内持续发起呼叫。 全局策略下的普通策略非空。 | | 5.13.4 | retryTimes | int | 每天最大试呼次数。 全局策略下的普通策略非空。 | | 5.13.5 | callInterval | int | 呼出间隔(秒)。 全局策略下的普通策略非空。 | | 5.13.6 | resultRetry | String | 根据结果配置策略的json串。 全局策略下根据结果配置策略非空。 该对象的参数说明请参见[表16]。 | | 5.13.7 | policyJson | String | - 根据号码类型匹配策略的json串。 - 号码类型匹配策略下非空。 - 全局策略时建议使用retryDay、retryTimes字段，不建议使用policyJson。 - 该对象的参数说明请参见[表20]。 | | 5.13.8 | busiPolicy | String | 业务结果策略的json串。 该对象的参数说明请参见[表19]。 | | 5.13.9 | noRetryPolicy | List\ | 不重试的结果码。即配置不重试的结果码，该结果码来源于"查询外呼结果定义列表"中的"data"属性下的"resultCode"字段。 | 表16resultRetry参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | result | int | - 结果类型。 - 全局策略的根据结果策略必填，取值范围：0-9。(1-客户忙，2-客户未接，3-客户拒接，4-空号，5-客户关机，6-客户不在服务区，7-传真、总机等，8-呼叫超时，9-呼叫失败，0-其他) | | 2 | displayResult | string | [外显结果id](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0796.html#ZH-CN_TOPIC_0000002481273878)，和result不能同时使用。 | | 3 | callInterval | int | 呼出间隔(秒)。 全局策略的根据结果策略非空。 | | 4 | retryNumber | int | 重试次数。 全局策略的根据结果策略非空。 | 表17callPolicy参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.14.1 | callPolicyId | String | 呼叫策略ID。 | | 5.14.2 | callType | int | 呼叫方式。 0，按顺序 1，按轮次。默认是按顺序。 | | 5.14.3 | chooseType | int | 轮次形式。 0，按号码分类 1，按号码序号。按轮次时非空。 | | 5.14.4 | turns | String | 轮次信息json串。 按轮次时非空。 该对象的参数说明请参见[表 turns参数说明]。 | | 5.14.5 | callOrder | int | 呼叫顺序。 - 0：无序呼叫 - 1：按序号 - 2：按数据属性 - 3：按优先级。 | | | totalCount | int | 轮次总数 | 表18turns参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.14.4.1 | turnType | String | 号码类型。 按号码分类时非空。 | | 5.14.4.2 | turnOrder | int | 号码序号。 按号码序号时非空。 | | 5.14.4.3 | orderNo | int | 轮次序号。 | 表19busiPolicy参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.13.8.1 | busiResultCode | String | 业务结果编码。 | | 5.13.8.2 | busiResultSubCode | String | 业务结果子编码。（跟业务结果编码关联） | | 5.13.8.3 | busiResultPolicy | int | 业务结果呼叫策略。 0-停止呼叫，1-呼叫下个号码，2-呼叫当前号码。 | | 5.13.8.4 | callInterval | int | 呼出间隔(秒)。 呼叫策略为0为空，其他非空。 | 表20policyJson参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.13.7.1 | dataType | String | 号码类型。 9D9T9为默认类型。 | | 5.13.7.2 | type | int | 重试逻辑策略类型： - 0：普通策略 - 1：结果策略 | | 5.13.7.3 | policy | String | 策略配置相关信息。 该对象的参数说明请参见[表 policy参数说明]。 | 表21policy参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 5.13.7.3.1 | retryDay | int | 最大试呼天数。若号码外呼未成功，允许在后续连续多个自然日内持续发起呼叫。 根据号码类型匹配策略的普通策略非空。 | | 5.13.7.3.2 | retryTimes | int | 每天最大试呼次数。 根据号码类型匹配策略的普通策略非空。 | | 5.13.7.3.3 | result | int | 结果类型。 根据号码类型匹配策略的结果策略非空。 | | 5.13.7.3.4 | callInterval | int | 呼出间隔(秒)。 根据号码类型匹配策略的结果策略非空。 | | 5.13.7.3.5 | retryNumber | int | 重试次数。 根据号码类型匹配策略的结果策略非空。 | 表22blocklistParam参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | useTenantBlocklist | boolean | False | 是否启用租户级黑名单校验，不传值时默认为true | | 2 | useOrgBlocklist | boolean | False | 是否启用组织级黑名单校验，不传值时默认为true，当组织隔离开启时生效 | | 3 | blocklistGroup | List\ | False | 黑名单分组列表 | 表23callRuleParam参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 5.1 | id | String | False | - 外呼规则ID，如果未填写，则默认为租户级异常呼叫规则。 - 不支持手动外呼、人工分配外呼。 | 表24specialHolidayList参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | holidayId | int | True | - 自定义的节假期id。 - 如果所有节假日的可呼叫时间一致，可通过设置活动中的holidayBeginTime1、holidayEndTime1参数区分。 - 每个特殊日期最少设置一个时间段。 | | 2 | beginTime1 | String | False | 可呼叫开始时间1，格式HH:MM | | 3 | endTime1 | String | False | 可呼叫结束时间1，格式HH:MM | | 4 | beginTime2 | String | False | 可呼叫开始时间2，格式HH:MM | | 5 | endTime2 | String | False | 可呼叫结束时间2，格式HH:MM | | 6 | beginTime3 | String | False | 可呼叫开始时间3，格式HH:MM | | 7 | endTime3 | String | False | 可呼叫结束时间3，格式HH:MM | 表25callerNoDatas参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | accessCode | String | True | 主叫号码。 呼通客户后，客户的电话终端上显示的号码。 最大长度为24个字符，有效字符为：0\~9。 | | 2 | priority | int | True | 主叫号码优先级。 取值范围：1-5。数字越小，优先级越高 | | 3 | calledPrefix | String | False | 被叫号码字冠 | 表26dataPolicy参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 17.1 | dataExpireDuration | int | False | 外呼数据过期时长，默认时长为10天，即10天不进行呼叫，数据机会转移到呼叫完成表中，最大支持设置为365。历史外呼任务值为365天。 | #### 触发事件 无 #### 错误结果码 表27错误原因码说明 | 序号 | 错误码 | 说明 | |:---|:---|:---| | 1 | 0200001 | 参数异常，异常详情在resultDesc中描述。 | | 2 | 0200006 | 数据库操作异常。 | | 3 | 0200007 | 外呼活动已经不存在。 | | 4 | 02000001 | 参数值为空 | | 5 | 02000002 | 参数包含非法字符 | | 6 | 02000003 | 参数长度不能大于规定长度 | | 7 | 02000004 | 参数长度不能小于规定长度 | | 8 | 02000005 | 参数长度需要介于规定长度之间 | | 9 | 02000006 | 参数值类型不正确 | | 10 | 02000007 | 参数值大小不正确 | | 11 | 02000008 | 参数转换异常，请检查请求参数 | | 12 | 02000009 | 参数组合不正确，请检查请求参数 | | 13 | 02000010 | hour和minute必须同时存在 | | 14 | 02000011 | 参数个数不能大于规定个数 | #### 报文样例 - 该接口的请求消息体举例如下： 无 - 该接口的响应消息体举例如下： ``` { "returnCode": "0200000", "returnObject": { "deviceType": 6, "callBackUrl": "", "retryPolicy": { "noRetryPolicy": "", "retryPolicyId": "174176532749388777623694972284", "policyType": 0, "busiPolicy": "", "policyJson": [ { "retryTimes": 2, "retryDay": 1, "type": 0, "policy": [] } ] }, "strEndTime": "2025-03-15 00:00:00", "strBeginTime": "2025-03-12 00:00:00", "description": "", "callerNoDatas": [ { "accessCode": "6300", "calledPrefix":"25415" "priority": 3, } ], "skillParam": { "skillName": "defaultAudioSkill", "skillId": 1, "outBoundType": "6" }, "priority": 2, "orgId": "", "ivrParam": null, "callerNo": "6300", "scheduleParam": { "holidayEndTime3": null, "holidayEndTime2": null, "workdayBeginTime2": "", "holidayEndTime1": null, "workdayBeginTime1": "00:00", "holidayBeginTime3": null, "workdayBeginTime3": "", "holidayBeginTime2": null, "workdayEndTime1": "23:59", "workdayEndTime2": "", "workdayEndTime3": "", "holidayBeginTime1": null }, "callPolicy": { "callPolicyId": "174176532749461315232315421287", "callOrder": 3, "totalCount": null, "callType": 0 }, "name": "call", "id": 1287074332, "maxAlertingTime": 20, "status": 2 }, "resultCode": "0200000", "resultDesc": "getTaskDetail task success", "returnDesc": "getTaskDetail task success" } ```