查询外呼活动详情

前置条件

已经申请了开发者账号。
外呼活动已建立。

场景描述

调用该接口查询指定外呼活动的详细配置。

接口方法

该接口仅支持GET方法。

接口URL

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。

请求说明

表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表示成功，其他表示失败。具体见表21
2	resultDesc	String	描述。
3	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表21
4	returnDesc	String	描述。
5	returnObject	Object	参见表4

表4 returnObject参数说明
序号	参数名	参数类型	说明
5.1	name	String	外呼活动的名称。
5.2	description	String	外呼活动的描述。
5.3	status	int	外呼活动的状态。取值范围： 2：已开始 3：暂停 4：已完成
5.4	strBeginTime	String	外呼活动开始时间。格式说明：yyyy-MM-dd HH:mm:ss
5.5	strEndTime	String	外呼活动结束时间。格式说明：yyyy-MM-dd HH:mm:ss
5.6	deviceType	int	外呼设备类型。取值范围： 1：智能外呼的IVR（SaaS环境下且智能化特性开启时可用） 2：预测外呼的技能队列 3：自动外呼的IVR 5：预览外呼的技能队列 6：预占外呼的技能队列
5.7	callerNo	String	主叫号码。呼通客户后，客户的电话终端上显示的号码。
5.8	maxAlertingTime	int	用户不应答最大振铃时长，超过该时长，则释放呼叫。
5.9	scheduleParam	Object	呼出时间段。该对象的参数说明请参见表5。
5.10	ivrParam	Object	deviceType为1，3（IVR）时非空。该对象的参数说明请参见表6。
5.11	skillParam	Object	deviceType为2，5，6（技能队列）时非空。该对象的参数说明请参见表7。
5.12	callBackUrl	String	外呼结果的回调通知地址。
5.13	retryPolicy	Object	外呼结果策略。该对象的参数说明请参见表14。
5.14	callPolicy	Object	呼叫策略。该对象的参数说明请参见表16。

表5 scheduleParam参数说明
序号	参数名	参数类型	说明
5.9.1	workdayBeginTime1	String	工作日呼出时间段1开始时间，格式为HH:mm。
5.9.2	workdayEndTime1	String	工作日呼出时间段1结束时间，格式为HH:mm。
5.9.3	workdayBeginTime2	String	工作日呼出时间段2开始时间，格式为HH:mm。
5.9.4	workdayEndTime2	String	工作日呼出时间段2结束时间，格式为HH:mm。
5.9.5	workdayBeginTime3	String	工作日呼出时间段3开始时间，格式为HH:mm。
5.9.6	workdayEndTime3	String	工作日呼出时间段3结束时间，格式为HH:mm。
5.9.7	holidayBeginTime1	String	特殊日期呼出时间段1开始时间，格式为HH:mm。
5.9.8	holidayEndTime1	String	特殊日期呼出时间段1结束时间，格式为HH:mm。
5.9.9	holidayBeginTime2	String	特殊日期呼出时间段2开始时间，格式为HH:mm。
5.9.10	holidayEndTime2	String	特殊日期呼出时间段2结束时间，格式为HH:mm。
5.9.11	holidayBeginTime3	String	特殊日期呼出时间段3开始时间，格式为HH:mm。
5.9.12	holidayEndTime3	String	特殊日期呼出时间段3结束时间，格式为HH:mm。

表6 ivrParam参数说明
序号	参数名	参数类型	说明
5.10.1	deviceSign	String	IVR主流程接入码。
5.10.2	callCount	int	外呼任务每次呼出的数量。
5.10.3	callInterval	int	外呼任务的呼出间隔时间，单位秒。

表7 skillParam参数说明
序号	参数名	参数类型	说明
5.11.1	skillId	int	技能队列的ID。
5.11.2	skillName	String	技能队列的名称。
5.11.3	outBoundType	int	呼出方式，取值范围： 2：预测外呼 5：预览外呼 6：预占外呼
5.11.4	predictParam	Object	outBoundType为2时为True，预测呼出时的参数配置。该对象的参数说明请参见表9。
5.11.5	previewParam	Object	outBoundType为5时为True，预览呼出时的参数配置。该对象的参数说明请参见表8。

表8 previewParam参数说明
序号	参数名	参数类型	是否必选	说明
5.11.5.1	failInterval	int	True	呼出间隔时间，正整数，单位秒。
5.11.5.2	obCallCount	int	True	每次呼出数量，正整数。
5.11.5.3	autoCallTime	int	True	预览自动呼叫时长，正整数，单位秒。

表9 predictParam参数说明
序号	参数名	参数类型	说明
5.11.4.1	predictMethod	int	预测外呼算法。取值范围： 1：经验预测算法 2：座席利用率预测算法 3：外呼接通率预测算法 5：摘机率预测算法
5.11.4.2	expPredictParam	Object	经验预测算法的参数配置，predictMethod为1（经验预测算法）时，非空。该对象的参数说明请参见表10。
5.11.4.3	agentPredictParam	Object	座席利用率预测算法的参数配置，predictMethod为2（座席利用率预测算法）时，非空。该对象的参数说明请参见表11。
5.11.4.4	connectPredictParam	Object	外呼接通率预测算法的参数配置，predictMethod为3（外呼接通率预测算法）时，非空。该对象的参数说明请参见表12。
5.11.4.5	offhookPredictParam	Object	摘机率预测算法的参数配置，predictMethod为5（摘机率预测算法）时，非空。该对象的参数说明请参见表13。

**表10** expPredictParam参数说明
序号	参数名	参数类型	说明
5.11.4.2.1	maxAvgCallTime	int	最大平均通话时长，单位秒。
5.11.4.2.2	mimAvgCallTime	int	最小平均通话时长，单位秒。
5.11.4.2.3	outBoundRate	int	呼出速率。

**表11** agentPredictParam参数说明
序号	参数名	参数类型	说明
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：表示座席利用率＝(总的通话时长＋工作态时长)/总的签入时长

**表12** connectPredictParam参数说明
序号	参数名	参数类型	说明
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	外呼接通率。

**表13** offhookPredictParam参数说明
序号	参数名	参数类型	说明
5.11.4.5.1	offHookRate	int	摘机率。

**表14** retryPolicy参数说明
序号	参数名	参数类型	说明
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串。全局策略下根据结果配置策略非空。该对象的参数说明请参见表15。
5.13.7	policyJson	String	根据号码类型匹配策略的json串。号码类型匹配策略下非空。该对象的参数说明请参见表19。
5.13.8	busiPolicy	String	业务结果策略的json串。该对象的参数说明请参见表18。
5.13.9	noRetryPolicy	String	不重试的结果码。即配置不重试的结果码，该结果码来源于“查询外呼结果定义列表”中的“data”属性下的“resultCode”字段。

**表15** resultRetry参数说明
序号	参数名	参数类型	说明
5.13.6.1	result	int	结果类型。全局策略的根据结果策略非空。
5.13.6.2	callInterval	int	呼出间隔(秒)。全局策略的根据结果策略非空。
5.13.6.3	retryNumber	int	重试次数。全局策略的根据结果策略非空。

**表16** callPolicy参数说明
序号	参数名	参数类型	说明
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参数说明。

**表17** turns参数说明
序号	参数名	参数类型	说明
5.14.4.1	turnType	String	号码类型。按号码分类时非空。
5.14.4.2	turnOrder	int	号码序号。按号码序号时非空。
5.14.4.3	orderNo	int	轮次序号。

**表18** busiPolicy参数说明
序号	参数名	参数类型	说明
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为空，其他非空。

**表19** policyJson参数说明
序号	参数名	参数类型	说明
5.13.7.1	dataType	String	号码类型。
5.13.7.2	type	int	重试逻辑策略类型： 0：普通策略 1：结果策略
5.13.7.3	policy	String	策略配置相关信息。该对象的参数说明请参见表 policy参数说明。

**表20** policy参数说明
序号	参数名	参数类型	说明
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	重试次数。根据号码类型匹配策略的结果策略非空。

触发事件

无

错误结果码

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

报文样例

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

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

{
    "resultCode": "0200000",
    "resultDesc": "",
    "returnCode": "0200000",
    "returnDesc": "",
    "returnObject": {
        "id": 146,
        "name": "lizhan_test",
        "description": null,
        "status": 2,
        "strBeginTime": "2018-12-01",
        "strEndTime": "2018-12-02",
        "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"
    }
}

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

上一篇：删除外呼活动

下一篇：查询外呼活动列表