查询外呼活动模板列表

场景描述

通过此接口可以查看外呼活动模板列表。

使用说明

前提条件
- 有对应的Ak/Sk鉴权权限。
- 已经申请了开发者账号。

接口方法

该接口仅支持GET方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/template?name={name}&status={status}&offset={ offset }&limit={ limit }

其中，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	外呼活动模板的状态。 1：草稿 9：已发布 3：暂停
4	taskType	int	False	外呼活动类型 1：智能机器人外呼 2：预测外呼 3：普通IVR外呼 5：预览外呼 6：预占外呼
5	offset	int	True	offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。
6	limit	int	True	表示每页的查询数量。取值范围：1～100。

响应说明

表2 消息体参数说明
序号	参数名	参数类型	说明
1	resultCode	String	原因码。0200000表示成功，其他表示失败。具体见下表4 错误原因码说明错误原因码说明。
2	resultDesc	String	描述。
3	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表4 错误原因码说明。
4	returnDesc	String	描述。
5	data	List	查询成功后，返回外呼活动信息的对象(CampaignTemplate)。
6	offset	int	offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。
7	limit	int	表示每页的查询数量。
8	totalSize	int	总条数

表3 data参数说明
序号	参数名	参数类型	说明
1	id	int	外呼活动模板id
2	name	String	外呼活动模板名称
3	status	int	外呼活动模板的状态。 1：草稿 9：已发布 3：暂停 .
4	taskType	int	外呼活动类型 1：智能机器人外呼 2：预测外呼 3：普通IVR外呼 5：预览外呼 6：预占外呼

错误结果码

表4 错误原因码说明
序号	错误码	说明
1	0200001	参数异常，异常详情在resultDesc中描述。
2	02000001	参数值为空
3	02000002	参数包含非法字符
4	02000007	参数值大小不正确

报文样例

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

{
    "returnCode": "0200000",
    "totalSize": 1,
    "data": [
        {
            "taskType": "2",
            "name": "cl_预测外呼模板",
            "id": "1052172768",
            "status": "9"
        }
    ],
    "offset": 0,
    "resultCode": "0200000",
    "limit": 5,
    "resultDesc": "query success",
    "returnDesc": "query success"
}

父主题： 外呼活动模板接口

上一篇：外呼活动模板接口

下一篇：查询外呼活动模板详情