创建双呼呼叫 (V1.0.0) (createCall)
场景描述
创建双呼呼叫。
双呼呼叫接口支持云客服系统的双呼呼叫和ITA双呼呼叫，具体是哪种双呼呼叫由租户管理员登录客户服务云系统前台界面，进入，进行选择。
接口方法
POST
接口URI
https://域名/apiaccess/CC-Management/v1/mobileAgent/createCall，例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1 |
X-APP-Key |
string |
False |
appKey字段，用户标识 |
2 |
Authorization |
string |
True |
鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1 |
caller |
string |
True |
主叫号码，客户经理手机号码，或是软电话号码 长度限制：string（32） |
2 |
called |
string |
True |
被叫号码 长度限制：string（32） |
3 |
agentWorkNo |
decimal |
False |
发起双呼的座席的工号。 长度限制：decimal（5） |
4 |
callData |
string |
False |
呼叫数据 长度限制：string（1024）
说明：
ITA双呼不支持callData字段。 |
5 |
callerPresent |
string |
False |
用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。
说明：
ITA双呼不支持callerPresent字段。 |
6 |
agentPresent |
string |
False |
座席侧主叫显示号码，客户经理看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。
说明：
ITA双呼不支持agentPresent字段。 |
7 |
callBackUrl |
string |
False |
此参数请采用BASE64编码进行加密。 此字段用于设置客户接收状态上报的挂机回调URL。 云客服CEC平台将业务触发过程中通话的状态信息推送至此服务器，客户服务器根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名，推荐使用域名，支持http和https。http为不安全协议，请谨慎使用。且该域名对应多个服务器，避免单点故障无法接收通知。 URL只能由大小写字母（a-z、A-Z），数字（0-9）， - : . / _ # ? &组成，不支持其它字符。 回调URL的域名或IP端口已通过系统管理员加入手机客服回调的地址白名单中。
须知：
如果入参callBackUrl不生效，可能是因为您所在的云客服环境接口未正常升级，请联系运管理员确认当前的发布态的API名称是否为createCall_kugui，如果不是，则暂时不能使用callBackUrl入参。 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
是否必选
说明
1.1
retCode
string
True
0：成功，其他为失败
1 ：添加外呼任务失败，外呼数据库中可能已存在相同外呼任务
2 ：呼叫数据信息
3 ：未查询出呼叫流水号字段
5 ：主被叫或外显号码格式不符
6 ：VDN不可用
8 ：主叫号码不在租户所分配的移动座席使用的软电话号码范围内
9 ：callBackUrl不符合条件
16 ：试用租户的座席侧号码未在白名单内
21 ：试用租户一键双呼超过每天10次限制
针对ITA双呼还有一些retCode，请参见表4
1.2
retMsg
string
True
失败原因的描述
1.3
result
object
False
返回结果
1.3.1
callSerialNo
number
False
呼叫流水号
表4 针对ITA双呼的retcode说明 retcode
retMsg
说明
90100100
Invalid Input Parameter
请求报文不正确。如缺少参数或者不支持的参数
90100200
Auth Failed
请求的来源或者请求的签名未通过校验
90100300
Bad Request
错误请求
90100400
Not found
请求资源不存在
90100600
Internal Server Error
系统内部错误
90102001
Insufficient Balance
额度不足
90102002
Request Restriction
请求限制
90104001
Insufficient Permission
权限不足
90104003
Request Forbidden
请求被禁止
90104004
Service Unavailable
不支持的业务功能或者未实现
90104008
Service Process Failure
业务处理超时或者处理失败
90104029
Too Many Requests
请求过多
90106001
Binding relationship already exists
小号绑定关系已存在
90106002
Binding relationship not exists
小号绑定关系不存在
90106003
Insufficient Number resources
小号号码池资源不足
90106004
No corresponding number found
未找到可用小号
90106005
Inconsistent binding data
小号绑定数据不一致
90106006
Other Error
小号其他原因导致错误
90106010
Policy Forbid
策略禁止
90106011
Caller Forbid
主叫限制
90106012
Callee forbid
被叫限制
- 响应状态码: 400
错误的请求：请检查请求路径及参数。
- 响应状态码: 401
未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到：请检查请求的路径。
- 响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。
错误码
无。
报文样例
请求头:
x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json
请求参数:
{
"caller": "88889050",
"called": "88889060",
"agentWorkNo": "",
"callerPresent": "640003",
"agentPresent": "640060",
"callData": "333333"
}
响应头:
{
"connection": "keep-alive",
"content-type": "application/json;charset=UTF-8"
}
响应参数:
{
"result": {
"callSerialNo": "1771078210739978242"
},
"retCode": "0",
"retMsg": "Created successfully."
}
