POST /ccmessaging/v1/mobileagent/createcall
描述
业务员通过登录APP调用chat提供的createcall接口创建匿名外呼任务,后续通过集成sdk发起匿名呼叫。
接口方法
POST
接口URI
https://域名/apiaccess/ccmessaging/v1/mobileagent/createcall,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
X-APP-Key |
string |
True |
appKey字段,用户标识,请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
called |
string(32) |
True |
被叫号码 |
1.2 |
callData |
string(1,024) |
False |
呼叫数据 |
1.3 |
callerPresent |
string(32) |
True |
用户侧主叫显示号码,用户看到的主叫号码,不携带的情况下,采用平台默认的主叫号码 |
响应说明
- 响应状态码: 200
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
resultCode |
string |
True |
接口返回码。 0:成功,其他为失败 30010000001:没有开通此特性,无法使用 30010000002:没有查到SIP Server 信息 30010000003:入参校验失败 30010010001:添加外呼任务失败 30010010002:VDN不可用 30010010003:VDN配置异常,Record Path生成失败 30010019999:CCM其他异常 30011010001:创建呼叫失败,未等到呼叫建立成功事件 30011019999:CCUCS其他异常 30010009999:Chat模块异常 |
1.2 |
resultDesc |
string |
False |
失败原因描述 |
1.3 |
resultData |
object |
False |
响应消息结构体 |
1.3.1 |
callSerialNo |
string(50) |
False |
呼叫序列号,唯一标示一次外呼 |
1.3.2 |
sipServiceAddress |
string |
True |
sip服务地址,ip:port |
1.3.3 |
accesscode |
string |
True |
用于VOIP匿名呼叫,接入码+uvid |
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:调用chat接口创建外呼任务
请求头:
{ "X-APP-Key": "***********************", "Authorization": "Bearer ***********************", "Content-Type": "application/json" }
请求参数:
{ "called":"88884432", "callData":"1", "callerPresent":"95599" }
响应头:
connection →keep-alive content-encoding →gzip content-length →130 content-type →application/json;charset=UTF-8 date →Wed, 12 May 2021 08:52:40 GMT server →openresty
响应参数:
{ "resultCode": "0", "resultDesc": "Success", "resultData": { "sipServiceAddress": "10.137.203.215:5063", "accesscode": "179080024609291" } }