文档首页/ 云客服/ API参考/ 外呼类接口参考/ 外呼批次接口/ 新增外呼批次
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

新增外呼批次

前置条件

  • 已经申请了开发者账号。
  • 外呼任务状态为草稿、执行中、暂停、已完成。

场景描述

通过该接口为指定外呼活动新增外呼批次。

接口方法

该接口仅支持POST方法。

接口URL

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

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

name

String

True
  1. 外呼批次名称，批次名称保持唯一性，最大长度为255个字符。
  2. 不允许输入特殊符号<>!@#$%^&*?;"~/\
  3. 受租户参数“任务中批次最大数量”限制，单个外呼任务默认最多创建100个批次，取值范围1-1000。

2

status

int

False

批次状态，

1：启动

2：暂停，默认暂停状态。

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见表6。

2

resultDesc

String

描述。

3

returnCode

String

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

具体见表6。

4

returnDesc

String

描述。

5

returnObject

Object

参见表5 returnObject参数说明。
表5 returnObject参数说明

序号

参数名

参数类型

说明

1

id

String

外呼任务批次id。

触发事件

无

错误结果码

表6 错误原因码说明

序号

错误码

说明

1

0200001

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

2

0200006

数据库操作异常。

3

0200007

外呼活动不存在。

4

02000001

参数值为空

5

02000002

参数包含非法字符

6

02000003

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

7

03000001

存在重复的批次名称。

8

03000002

外呼活动不允许添加批次。

9

03000003

超出任务最大批次数量，最大数量限制

报文样例

  • 该接口的请求消息体举例如下： 
    {
    "name": "test",
    "status": 1
}
  • 该接口的响应消息体举例如下： 
    {
    "returnCode": "0200000",
    "returnObject": {
        "id": "174712034211433247704877116507"
    },
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnDesc": "success"
}
父主题： 外呼批次接口

相关文档