文档首页/ 云客服/ API参考/ 电销外呼/ 外呼活动的特殊日期管理接口/ 查询外呼活动的特殊日期列表
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询外呼活动的特殊日期列表

前置条件

  • 已经申请了开发者账号。
  • 已经获取到外呼活动的ID。

场景描述

调用该接口查询指定外呼活动关联的特殊日期。

接口方法

该接口仅支持GET方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{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 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见表5。

2

resultDesc

String

描述。

3

data

List

查询成功后，返回的特殊日期信息列表数据。

参见表4。

4

returnCode

String

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

具体见表5

5

returnDesc

String

描述。
表4 data参数说明

序号

参数名

参数类型

说明

3.1

id

int

特殊日期的id。

3.2

name

String

特殊日期名称。

3.3

type

int

特殊日期的类型。

取值范围：

1：按周设置

2：按日期设置

3：按日期重复

3.4

week

String

星期，特殊日期的类型为按周设置时非空

取值范围：

1：星期一

2：星期二

3：星期三

4：星期四

5：星期五

6：星期六

7：星期天

同时选择多天时以逗号分隔，例如“6,7”表示星期六、星期天

3.5

beginTime

String

开始时间。

特殊日期的类型为2时，数据格式：yyyy-MM-dd

特殊日期的类型为3时，数据格式：MM-dd

3.6

endTime

String

结束时间。

特殊日期的类型为2时，数据格式：yyyy-MM-dd

特殊日期的类型为3时，数据格式：MM-dd

触发事件

无

错误结果码

表5 错误原因码说明

序号

错误码

说明

1

0200001

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

2

0200007

外呼活动不存在。

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": "",
    "data": [
        {
            "id": 11,
            "name": "周末",
            "type": 1,
            "week": "5,7",
            "beginTime": null,
            "endTime": null
        },
        {
            "id": 14,
            "name": "中秋节",
            "type": 2,
            "week": null,
            "beginTime": "2018-09-22",
            "endTime": "2018-09-24"
        }
    ]
}

相关文档