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

暂停外呼活动

前置条件

  • 已经申请了开发者账号。
  • 已经获取到需要暂停的外呼活动的ID。
  • 外呼活动处于启动中。

场景描述

调用该接口将指定外呼活动状态改为暂停。

接口方法

该接口仅支持PUT方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId}/pause

其中，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表示成功，其他表示失败。

具体见表4。

2

resultDesc

String

描述。

3

returnCode

String

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

具体见表4。

4

returnDesc

String

描述。

触发事件

无

错误结果码

表4 错误原因码说明

序号

错误码

说明

1

0200001

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

2

0200006

数据库操作异常。

3

0200007

外呼活动已经不存在。

4

0200011

当前状态不允许暂停。

5

02000001

参数值为空

6

02000002

参数包含非法字符

7

02000003

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

8

02000004

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

9

02000005

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

10

02000006

参数值类型不正确

11

02000007

参数值大小不正确

12

02000008

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

13

02000009

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

14

02000010

hour和minute必须同时存在

15

02000011

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

报文样例

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

    无

  • 该接口的响应消息体举例如下： 
    {
    "resultCode": "0200000",
    "resultDesc": "",
    "returnCode": "0200000",
    "returnDesc": ""
}

相关文档