更新时间:2023-12-19 GMT+08:00

查询外呼活动列表

场景描述

调用该接口按照指定条件查询外呼活动。

接口方法

该接口仅支持GET方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage}

其中,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

外呼活动的状态。

取值范围:

2:已开始

3:暂停

4:已完成

输入值为0时默认查询全部状态。

4

deviceType

int

True

外呼设备类型。

取值范围:

  • 1:智能外呼
  • 2:预测外呼的技能队列
  • 3:自动外呼的IVR
  • 5:预览外呼的技能队列
  • 6:预占外呼的技能队列

输入值为0时默认查询全部类型。

5

beginTime

String

False

外呼活动的最小开始时间,格式为yyyy-MM-dd HH:mm:ss。

6

endTime

String

False

外呼活动的最大结束时间,格式为yyyy-MM-dd HH:mm:ss。

7

curPage

int

True

当前第几页。

默认值为1,输入值小于1时自动修正为1。

8

rowsPerPage

int

True

每页记录数。

该值不输入的时候,默认查询10条,且最大值为100。

9

ccId

int

False

传了就按指定的ccid过滤,不传就不过滤

请求说明

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

无请求消息体。

响应说明

表3 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

原因码。0200000表示成功,其他表示失败。

具体见表5

2

resultDesc

String

描述。

3

returnCode

String

原因码。0200000表示成功,其他表示失败。

具体见表5

4

returnDesc

String

描述。

5

curPage

int

当前页。

6

totalSize

int

总记录数。

7

rowsPerPage

int

每页记录数。

8

curSkillQueueCount

int

当前技能队列外呼活动总数。

9

curIvrCount

int

当前IVR外呼活动总数。

10

data

List

查询成功后,返回外呼活动信息的对象(Campaign)。

参见表4

表4 Campaign参数说明

序号

参数名

参数类型

说明

10.1

id

int

外呼活动id。

10.2

name

String

外呼活动的名称。

10.3

status

int

外呼活动的状态。

取值范围:

2:已开始

3:暂停

4:已完成

10.4

strBeginTime

String

外呼活动开始时间。

10.5

strEndTime

String

外呼活动结束时间。

10.6

deviceType

int

外呼设备类型。

取值范围:

  • 1:智能外呼
  • 2:预测外呼的技能队列
  • 3:自动外呼的IVR
  • 5:预览外呼的技能队列
  • 6:预占外呼的技能队列

10.7

callerNo

String

主叫号码。

呼通客户后,客户的电话终端上显示的号码。

触发事件

错误结果码

表5 错误原因码说明

序号

错误码

说明

1

0200001

参数异常,异常详情在resultDesc中描述。

2

0200006

数据库操作异常。

3

02000001

参数值为空

4

02000002

参数包含非法字符

5

02000003

参数长度不能大于规定长度

6

02000004

参数长度不能小于规定长度

7

02000005

参数长度需要介于规定长度之间

8

02000006

参数值类型不正确

9

02000007

参数值大小不正确

10

02000008

参数转换异常,请检查请求参数

11

02000009

参数组合不正确,请检查请求参数

12

02000010

hour和minute必须同时存在

13

02000011

参数个数不能大于规定个数

报文样例

  • 该接口的请求消息体举例如下:

  • 该接口的响应消息体举例如下:
    {
        "resultCode": "0200000",
        "resultDesc": "",
        "returnCode": "0200000",
        "returnDesc": "",
        "curPage": 1,
        "totalSize": 3,
        "rowsPerPage": 10,
        "data": [
            {
                "id": 3,
                "name": "666",
                "status": 1,
                "strBeginTime": "2018-11-30",
                "strEndTime": "2018-11-30",
                "deviceType": 2,
                "callerNo": "10080"
            },
            {
                "id": 4,
                "name": "666333696",
                "status": 1,
                "strBeginTime": "2018-11-30",
                "strEndTime": "2018-11-30",
                "deviceType": 2,
                "callerNo": "10080"
            },
            {
                "id": 2,
                "name": "SAAS_JST",
                "status": 3,
                "strBeginTime": "2018-11-29",
                "strEndTime": "2018-12-08",
                "deviceType": 2,
                "callerNo": "10080"
            }
        ],
        "curSkillQueueCount": 3,
        "curIvrCount": 0
    }