PNS API bind AX - nxtele/http-api-document GitHub Wiki
接口说明
A(n) X (n)
请求url
https://api.nxcloud.com/v1/api/pns/
请求头
| 参数名 |
类型 |
必填 |
说明 |
示例值 |
| accessKey |
string |
是 |
用户的accessKey |
fme2na3kdi3ki |
| action |
string |
是 |
请求方法 |
bindAX |
| bizType |
string |
是 |
[业务类型] 固定值 用来标识隐私号服务 |
5 |
| ts |
string |
是 |
当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒 |
1655710885431 |
| sign |
string |
是 |
API入参参数签名，签名算法 |
|
请求体
| 参数名 |
必填 |
类型 |
说明 |
| phoneA |
是 |
string |
A的号码，A、X号码的国码须保持一致 A,123 格式代表这是分机号码， 123 相当于ExtensionA |
| phoneX |
是 |
string |
预期绑定的X号码，须与A号码的国码保持一致 |
| extensionA |
否 |
string |
分机号，最长6位，如果A号码中有分机号，则不需要传 |
| extensionB |
否 |
string |
分机号，最长6位 |
| customerBindId |
否 |
string |
客户自定义的绑定id（由客户决定，需要保证唯一），可为空 |
| flag |
否 |
int |
其他标识,比特组合,0:none,1:录音 |
| expireSecond |
是 |
int |
过期秒数,若是为0，代表不过期 |
| dtmfDelayTime |
否 |
int |
延迟按键时间，单位：秒，仅用于自动输入分机号场景，需大于收号等待时间,默认是1s。 |
返回参数
| 参数名 |
类型 |
说明 |
| code |
int |
返回码，0代表成功，其他失败 |
| msg |
string |
返回码描述 |
| requestId |
string |
请求id |
| data |
Object |
请求数据id |
| data返回参数详情： |
|
|
| 参数名 |
类型 |
说明 |
| bindId |
string |
pns的绑定id，后续计费都会基于此 |
| did |
string |
pns的绑定虚拟号码 |
请求示例
请求url
https://api.nxcloud.com/v1/api/pns/
Header
| KEY |
VALUE |
| accessKey |
sixgqophrnv4 |
| ts |
1670479632933 |
| bizType |
5 |
| action |
bindAX |
| sign |
faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4 |
Body
{
"phoneA": "44********01",
"phoneX": "44********77",
"extensionA": "4**6",
"extensionB": "1**3",
"customerBindId": "2*****************sw",
"flag": 1,
"customerId": "test_user",
"businessId": "test_busi",
"expireSecond": 6000
}
返回示例
{
"code": 0,
"msg": "success",
"requestId": "16**********04",
"data": {
"bindId": "f6e24e****************e3b582ici",
"did": "44***********51"
}
}