读取外呼数据接口
场景描述
用于OBS获取和某任务外呼数据相关信息。
接口方法
Post
接口URI
https://域名/rest/isales/v1/openapi/obs/business/callnos,例如域名是service.besclouds.com。
请求说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
Authentication |
string |
True |
token鉴权字段,请配置为鉴权接口中返回的refreshToken参数值。 |
|
2 |
Content-Type |
String |
False |
"application/json" |
|
序号 |
参数 |
是否必选 |
类型 |
描述 |
|
1 |
subCCNo |
True |
int |
呼叫中心ID。 |
|
2 |
vdnId |
True |
int |
虚拟呼叫中心ID:VDNID。 |
|
3 |
serviceId |
True |
int |
外呼任务关键字。 |
|
4 |
batchCount |
True |
int |
本次批量取出的记录数 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
说明
1
result
string
错误码。取值如下:
0:成功
非0:失败
2
resultData
Object
查询成功后,返回结果信息的对象。
表4 resultData对象 序号
参数
类型
描述
1
version
String
版本信息
2
seviceId
String
外呼任务id
3
uniqueId
String
客户标识号。
4
phoneNumber
Array
被叫号码
5
callData
String
外呼座席收到的呼叫数据内容。
6
callerNumber
String
主叫号码
7
ieData
String
分为两部分:
- 外呼携带的IE指示信息。 格式为:IEName:域名1=域值1,域名2=域值2,……域名n=域值n; 举例:RedInfo :RedInd=1,OldRes=1,Res=1,Count=2;RedNumber: NumPlan=0, NumType=0, NumSi=0, NumPi=0, Number=9558800; 另外该字段可实现特定主叫号码的显示,格式为:callerno:callernumber=12345; 该参数值中的“,”、“;”、“:”都必须为半角字符,字母不区分大小写,中间不要有空格。
- 外呼携带的SIP数据。
格式:sipdatahead:x-charge:Bob sip:bob@biloxi.com;tag=a\6c,85cf#%#%
x-vdf:vender name#$#$
其中“#$#$”为结束符,用于以后扩展。“#%#%”为各头域的分隔符。
注意:第一部分,与第二部分的顺序不能改变,即SipData数据一定在IEData最后一部分。
错误码
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 403
鉴权失败。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
报文样例
- 请求头:
Authentication:Bearer e3fca9398eaa5cef4b57b523b9c75fae Content-Type:application/json
- 请求消息:
{
"version":311
}
- 响应消息:
{ "result":0, // 0:成功,其他失败 "resultData": { "taskData":[ { "seviceId:"fadsfa", "uiqueId":"sfa", "phoneNumber":["10086","1008611"], "callData":"1s56fas68dasf", "callerNumber":"10086", "ieData":"xxx" } ] } }