绑定接口
简要描述
通过该接口可以将号码A通过orderID与号码B进行绑定,号码A+orderID跟号码B一对一匹配。号码绑定的同时返回sip话机的鉴权信息sipId和sipPassword。
A呼叫B场景中,可以通过号码A+orderID找到号码B。B呼叫A场景中,可以通过号码B直接找到号码A。
比如派送场景中,号码A为派送员号码,号码B为客户号码。
A号码绑定多个B号码时,通过orderID进行区分。通过手机拨打X号码时,存在多个绑定关系时,接通后输入orderId转接到对应B号码
对同一个订单进行多次绑定时进行覆盖操作。
请求URL
请求方式
- post
Header
header | 必选 | 类型 | 说明 |
---|---|---|---|
Content-Type | 是 | string | application/json; charset=utf-8 |
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | string | 必须 | 通过授权接口获取的token |
telA | 是 | string | 号码A |
telB | 是 | string | 号码B |
orderId | 是 | string | 流水号,一般设置为4位以内的数字。在telA绑定多个telB时,telA通过手机拨打,在拨号盘输入orderId转到指定的telB,如果telA是sdk方式拨打,保证orderid不重复即可。 |
expiration | 否 | Integer | 绑定关系有效时间,单位秒,如果不传为永久有效 |
userData | 否 | string | 用户自定义数据,比如订单号 |
请求示例
{
"telA":"100001",
"telB":"138000001",
"orderId":"20210517020182123",
"expiration":72000,
"userData":"10000100101001"
}
返回示例
{
"msg":"绑定成功",
"code":"0000",
"data":{
"sipId":"100001",
"sipPassword":"xxxxx",
"sipIP":"192.168.1.23"
"sipPort":"9060",
"wsAddress": "wss://sip.v-call.cn:8443"
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
msg | string | 返回说明 |
code | String | 返回code |
data | Object | 返回数据 |
data说明
参数名 | 类型 | 说明 |
---|---|---|
sipId | String | sip鉴权id |
sipPassword | String | sip鉴权密码 |
sipIP | String | sip服务器ip |
sipPort | String | sip服务器端口 |
wsAddress | String | websocket地址 |
code说明
code | msg | 说明 |
---|---|---|
0000 | 绑定成功 | |
0001 | 覆盖绑定成功 | 可对相同的号码B进行重复绑定,绑定时覆盖 |
2001 | 绑定失败,telA为空 | |
2002 | 绑定失败,telA为空 | |
2003 | 绑定失败,orderID为空 | |
2004 | 绑定失败,expiration格式错误 |
文档更新时间: 2023-03-20 04:16 作者:刘强