查询外呼活动重试策略

前置条件

已经申请了开发者账号。
智能外呼时，需要客户开发IVR，具体详情请参考配置智能机器人。

场景描述

调用该接口查询指定外呼活动的重试策略信息。

接口方法

该接口仅支持GET方法。

接口URL

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。

请求说明

表2 请求消息头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	String	True	固定填 application/json; charset=UTF-8。
2	Authorization	String	True	生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
3	locale	String	False	i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。

无请求消息体。

响应说明

表3 消息体参数说明
序号	参数名	参数类型	说明
1	resultCode	String	原因码。0200000表示成功，其他表示失败。具体见表8。
2	resultDesc	String	描述。
3	data	Object	外呼重试策略。具体参见表4。
4	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表8。
5	returnDesc	String	描述。

表4 data参数说明
序号	参数名	参数类型	说明
3.1	retryPolicyId	String	重试策略ID。
3.2	policyType	int	重试策略类型： 0为全局策略 1为号码分类策略
3.3	policyJson	String	重试策略参数。具体见表5
3.4	noRetryPolicy	String	不重试的结果码。即配置不重试的结果码，该结果码来源于“查询外呼结果定义列表”中的“data”属性下的“resultCode”字段。
3.5	busiPolicy	String	False 业务结果策略的json串。该对象的参数说明请参见表6。

表5 policyJson参数说明
序号	参数名	参数类型	说明
3.3.1	dataType	String	号码类型。
3.3.2	policy	String	按照结果匹配的策略json串。该对象的参数说明请参见表 policy参数说明
3.3.3	retryDay	int	普通策略，试呼天数。
3.3.4	retryTimes	int	普通策略，每天试呼次数。
3.3.5	type	int	重试逻辑策略类型： 0：普通策略 1：结果策略

表6 busiPolicy参数说明
序号	参数名	参数类型	是否必选	说明
14.7.1	busiResultCode	String	True	业务结果编码。
14.7.2	busiResultSubCode	String	--	业务结果子编码。（跟业务结果编码关联）
14.7.3	busiResultPolicy	int	True	业务结果呼叫策略。 0-停止呼叫，1-呼叫下个号码，2-呼叫当前号码。
14.7.4	callInterval	int	--	呼出间隔(秒)。呼叫策略为0时不用填写，其他为True。取值范围：1-3600。

表7 policy参数说明
序号	参数名	参数类型	说明
3.3.2.1	callInterval	int	延迟时间。
3.3.2.2	result	int	结果类型。
3.3.2.3	retryNumber	int	重试次数。

触发事件

无

错误结果码

表8 错误原因码说明
序号	错误码	说明
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	参数个数不能大于规定个数

报文样例

该接口的请求消息体举例如下：
无

该接口的响应消息体举例如下：

{
  "returnCode": "0200000",
  "data": {
    "retryPolicyId": "1871694313",
    "policyType": 0,
    "policyJson": "[{'retryTimes':1,'retryDay':2,'type':0,'policy':[]}]"
  },
  "returnDesc": null
}

父主题：外呼活动管理接口

上一篇：设置外呼活动重试策略

下一篇：新增外呼业务结果定义