PNS BIND AXYB - nxtele/http-api-document GitHub Wiki
接口说明: 绑定axyb模式
概述
- 主叫号码a通过拨打隐私号X,转接成隐私号y拨打被叫号码B,保护a、b双方号码不被泄露,且能通过隐私号的xy角色,标识不同的对端用户a、b
- 适用场景:需要区分不同主叫用户的情况
请求方式
- URL:
https://api.nxcloud.com/v1/pns/bind/axyb
- Method:
POST
- Content-Type:
application/json
- 是否需要鉴权:
是
鉴权机制
请求参数说明
参数名 |
类型 |
必填 |
说明 |
示例值 |
accessKey |
string |
是 |
用户的accessKey |
fme2na3kdi3ki |
action |
string |
是 |
请求方法 |
bindAXYB |
bizType |
string |
是 |
[业务类型] 固定值 用来标识隐私号服务 |
5 |
ts |
string |
是 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
1655710885431 |
sign |
string |
是 |
API入参参数签名,签名算法 |
|
参数名 |
必填 |
类型 |
说明 |
businessId |
是 |
string |
应用key |
phoneA |
是 |
string |
A的号码,号码格式:需要带国码前缀 |
phoneB |
是 |
string |
B的号码,号码格式:需要带国码前缀 |
bindExpireSecond |
是 |
int |
绑定关系过期秒数,默认7200s |
didX |
否 |
string |
预期绑定的X号码,有值时选择固定DID,无值时随机选择DID |
didY |
否 |
string |
预期绑定的y号码,有值时选择固定DID,无值时随机选择DID |
customerBindId |
否 |
string |
客户自定义的绑定id(由客户决定,需要保证唯一) |
delayedGetY |
否 |
boolean |
延迟分配y号码,默认false |
recording |
否 |
boolean |
默认值为false |
ext |
否 |
string |
自定义字段,会在话单时透传 |
iso2X |
否 |
string |
didX的iso2, 当didX没有传时,该值可以指定didX的方向 |
iso2Y |
否 |
string |
didY的iso2, 当didY没有传时,该值可以指定didY的方向 |
返回参数说明
参数名 |
类型 |
说明 |
code |
int |
返回码,0代表成功,其他失败 |
msg |
string |
返回码描述 |
requestId |
string |
请求id |
data |
Object |
请求数据id |
data返回参数详情:
参数名 |
类型 |
说明 |
bindId |
string |
绑定id |
didX |
string |
绑定的x号码 |
didY |
string |
绑定的y号码 |
请求示例
curl --location --request POST 'https://api.nxcloud.com/v1/pns/bind/axyb' \
--header 'action: bindAXYB' \
--header 'bizType: 5' \
--header 'accessKey: yyds' \
--header 'Content-Type: application/json' \
--header 'ts: 1728367890316' \
--header 'sign: af40432dffba76f4e5f528238242db86' \
--data-raw '{
"phoneA": "85254987987",
"phoneB": "85264654798",
"bindExpireSecond": 300,
"customerBindId": "fertertrytry89798798dsfs97dfsdf",
"ext": "it is ext",
"recording": false
}'
返回示例
{
"code": 0,
"msg": "success",
"requestId": "1843534666482585600",
"data": {
"bindId": "26105f52c8d92c1f4646f078c4f1b300",
"didX": "8521321654",
"didY": "8521321655"
}
}