查询外呼业务结果定义列表

前置条件

已经申请了开发者账号。

场景描述

调用该接口查询指定虚拟呼叫中心下的外呼业务结果定义列表。

接口方法

该接口仅支持GET方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryBusinessResults?pageSize={pageSize}&pageNum={pageNum}

其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。

表1 URL中携带的参数说明
序号	参数名	参数类型	是否必选	说明
1	vdnId	int	True	虚拟呼叫中心ID。取值的类型为整数，取值范围为1～9999。
2	pageSize	int	True	分页查询结果，每页查询数据条数取值范围：1-50。
3	pageNum	int	True	当前页码。取值范围：正整数。

请求说明

表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表示成功，其他表示失败。具体见表6。
2	resultDesc	String	描述。
3	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表6。
4	returnDesc	String	描述。
5	data	JSONArray	结果json，详见表4。
6	totalCount	Long	返回列表中结果总条数。

表4 data参数说明
序号	参数名	参数类型	说明
5.1	name	String	业务结果名称。
5.2	code	String	业务结果编码。
5.3	defLevel	String	业务结果层次（1表示父业务结果，2表示子业务结果）。
5.4	children	List	子业务结果。该对象的参数说明请参见表5。

表5 children参数说明
序号	参数名	参数类型	说明
5.4.1	name	String	子业务结果名称。
5.4.2	code	String	子业务结果编码。
5.4.3	defLevel	String	业务结果层次（1表示父业务结果，2表示子业务结果）。

触发事件

无

错误结果码

表6 错误原因码说明
序号	错误码	说明
1	0200001	参数异常，异常详情在resultDesc中描述。
2	0200005	参数异常，异常详情在resultDesc中描述。
3	0200007	参数异常，异常详情在resultDesc中描述。
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",
  "data": [
    {
      "code": "11111",
      "children": [
        {
          "code": "12324",
          "name": "sub02",
          "defLevel": "2"
        },
        {
          "code": "1232",
          "name": "sub01",
          "defLevel": "2"
        }
      ],
      "name": "test111",
      "defLevel": "1"
    },
    {
      "code": "test",
      "children": [],
      "name": "test0903",
      "defLevel": "1"
    },
    {
      "code": "15105671",
      "children": [
        {
          "code": "754646",
          "name": "通话中断",
          "defLevel": "2"
        },
        {
          "code": "ob-12",
          "name": "多个地方官",
          "defLevel": "2"
        }
      ],
      "name": "失败4up",
      "defLevel": "1"
    }
  ],
  "resultCode": "0200000",
  "resultDesc": "queryBusinessResults Success!",
  "totalCount": 3,
  "returnDesc": "queryBusinessResults Success!"
}

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

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

下一篇：外呼异常分类统计