新增主叫号码
场景描述
调用该接口为指定外呼活动新增主叫号码。
使用说明
- 前提条件
- 已经申请了开发者账号。
- 外呼活动已经创建。
- 使用限制
- 同一个外呼任务,每次只能增加100条,总共不能超过设置的系统参数。
- 每次追加的主叫号码不能有重复。
- op场景was没开启“限制VDN主叫号码”的开关或者saas环境不能随意加。
接口方法
该接口仅支持POST方法。
接口URI
https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callerNo/{campaignId}
其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。
序号 |
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
vdnId |
int |
True |
虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 |
2 |
campaignId |
int |
True |
外呼活动的ID。 |
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
String |
True |
固定填 application/json; charset=UTF-8。 |
2 |
Authorization |
String |
True |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
序号 |
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
callerNo |
List |
True |
支持多主叫号码。最多100个号码。 该对象的参数说明请参见表4 |
响应说明
触发事件
无
错误结果码
序号 |
错误码 |
说明 |
---|---|---|
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 |
参数个数不能大于规定个数 |
报文样例
- 该接口的请求消息体举例如下:
{"callerNo":[ {"accessCode":"12345678901234","priority":1}, {"accessCode":"525245","priority":2} ]}
- 该接口的响应消息体举例如下:
{ "resultCode": "0200000", "resultDesc": "create callerNo success", "returnCode": "0200000", "returnDesc": "create callerNo success" }