1、创建关联关系接口
接口地址:openapi/call/api/axb/create 请求方式:POST
字段说明
字段名称 | 类型 | 约束 | 说明 |
requestId | string(36) | 必须 | 每次请求的唯一标识 |
telA | string(20) | 必须 | 一般放主叫号码 |
telX | string(20) | 必须 | 小号 |
telB | string(20) | 必须 | 一般放被叫号码 |
expiration | int | 可选 | 有效时间,单位:秒,缺省有效时间为 3600(即 1 小时)有效值范围为 1 至 604800(即 7 天) 创建关联完成后计为起始时间, 同时系 统也会将“起始时间+有效时间”计算并 保存一个结束 |
请求示例
{
"requestId": "1234333",
"telA": "137782207",
"telX": "173075722",
"telB": "183029784"
}
请求响应
字段名称 | 类型 | 约束 | 说明 |
code | int | 必须 | 状态码,200 表示成功 其他表示失败 |
msg | string | 条件 | 失败时,错误原因描述必填 |
data | DataInfo | 条件 | 200 时,数据必填 |
DataInfo | |||
seqId | string(32) | 必须 | 绑定关系的序列号 |
2、删除关联关系接口
该接口用于在生效时间到期自动删除前,提前删除号码的绑定关系
接口地址:call/api/axb/delete
请求方式:POST
字段说明:
字段名称 | 类型 | 约束 | 说明 |
requestId | string(36) | 非必须 | 每次请求的唯一标识 |
seqId | string(32) | 必须 | 绑定关系的序列号 |
telX | string(20) | 必须 | 必填 |
请求响应
字段名称 | 类型 | 约束 | 说明 |
code | int | 必须 | 状态码,200 表示成功 其他表示失败 |
msg | string | 条件 | 失败时,错误原因描述必填 |
3、CDR 推送接口
接口提供方:客户
字段名称 | 类型 | 约束 | 说明 |
id | string (32) | 必须 | 语音为 call-id |
serviceType | string (8) | 必须 | 业务类型:voice |
inboundCaller | string (20) | 必须 | 呼入主叫 |
inboundCallee | string (20) | 必须 | 呼入被叫 |
outboundCaller | string (20) | 必须 | 呼出主叫 |
outboundCallee | string (20) | 必须 | 呼出被叫 |
connectTime | string (20) | 可选 | 接通时间 |
endTime | string (20) | 可选 | 呼叫结束时间 |
talkTime | int(8) | 可选 | 通话时长,单位:秒 |
recordUrl | string (256) | 条件 | 录音文件提取方式向企业客户推送录音时 |
注:录音保存时间为 3 个月
4、绑定接口
POST /call/util/BX/bind请求体
参数名 | 类型 | 是否必填 | 说明 |
telB | String | Y | 主叫号码-座席自己手机号 |
telX | String | Y | 工作号码-小号 |
示例
{
"telB": "13856789123",
"telX": "15923456789"
}
返回结果
参数名 | 类型 | 是否必填 | 说明 |
success | boolean | Y | 是否成功 |
message | String | Y | 提示消息 |
data | String | Y | XB绑定的关系id |
code | String | Y | 成功:200 |
traceId | String | Y | 请求唯一标识 |
示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data":"xxxxx1112",
"traceId": "76e0770ec0f14d3fb5a8f1cde9bf89f0"
}
5、解绑接口
POST /call/util/BX/unbind请求体
参数名 | 类型 | 是否必填 | 说明 |
telB | String | Y | 主叫号码 |
telX | String | Y | 工作号码 |
示例
{
"telB": "13856789123",
"telX": "15923456789"
}
返回结果
参数名 | 类型 | 是否必填 | 说明 |
success | boolean | Y | 是否成功 |
message | String | Y | 提示消息 |
data | String | Y | XB绑定的关系id |
code | String | Y | 成功:200 |
traceId | String | Y | 请求唯一标识 |
示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data":"xxxxx1112",
"traceId": "76e0770ec0f14d3fb5a8f1cde9bf89f0"
}
6、绑定回调接口
POST 客户方提供请求体
参数名 | 类型 | 是否必填 | 说明 |
status | Y | String | 工作号当前状态:6:实名失败 7:实名过期 8:待实名 9:实名成功 |
telB | Y | String | 主叫号码 |
telX | Y | String | 工作号码 |
authId | Y | String | 工作号关系绑定的唯一标识 |
desc | N | String | 实名绑定失败原因描述 |
示例
{
"telB": "13856789123",
"telX": "15923456789"
"status": "6",
"authId": "1233",
"desc": "实名失败"
}
说明:返回code为200表示接收成功
7、解绑回调接口
POST 客户方提供请求体
参数名 | 类型 | 是否必填 | 说明 |
status | Y | String | 工作号当前状态:5:待使用 11:解绑失败 |
telB | Y | String | 主叫号码 |
telX | Y | String | 工作号码 |
authId | Y | String | 工作号关系绑定的唯一标识 |
desc | N | String | 号码解绑失败原因描述 |
示例
{
"telB": "13856789123",
"telX": "15923456789"
"status": "11",
"authId": "1233",
"desc": "解绑失败"
}
说明:返回code为200表示接收成功