PNS API bind AXG - nxtele/http-api-document GitHub Wiki

接口说明，添加AXG号码的绑定关系

请求url

https://number.nxcloud.com/api/pns/

请求头

参数名	类型	必填	说明	示例值
accessKey	string	是	用户的accessKey	fme2na3kdi3ki
action	string	是	请求方法	bindAXG
bizType	string	是	[业务类型] 固定值 用来标识隐私号服务	5
ts	string	是	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒	1655710885431
sign	string	是	API入参参数签名，签名算法

请求体

参数名	必填	类型	说明
phoneA	是	string	A的号码，A、B号码与号码组中号码的国码须保持一致；绑定后G可虚拟号码拨打A
phoneX	否	string	指定绑定虚拟号码，若不指定，则从号码池中取剩余绑定关系最多的号码
phoneB	否	string	A通过虚拟号码回拨B号码，需为号码组中的号码；如为空则A不可通过虚拟号码回拨
groupId	是	string	绑定的号码组id
customerBindId	否	string	客户自定义的绑定id（由客户决定，需要保证唯一），可为空
flag	否	int	其他标识,比特组合,0:none,1:录音
expireSecond	是	int	过期秒数,若是为0，代表不过期

返回参数

参数名	类型	说明
code	int	返回码，0代表成功，其他失败
msg	string	返回码描述
requestId	string	请求id
data	Object	返回数据

data返回参数详情：

参数名	类型	说明
bindId	string	pns的绑定id，后续计费都会基于此
did	string	pns的绑定虚拟号码

请求示例

请求url

https://number.nxcloud.com/api/pns/

Header

KEY	VALUE
accessKey	sixgqophrnv4
ts	1670479632933
bizType	5
action	bindAXG
sign	faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4

Body

{
    "phoneA": "85211111114",
    "phoneX": "85235753351",
    "phoneB": "85235755551",
    "groupId": "1602484f91adb0b60e",
    "customerBindId": "10001",
    "flag": 1,
    "expireSecond": 1011
}

返回示例

{
  "code": 0,
  "msg": "success",
  "requestId": "1602248485121429504",
  "data": {
    "bindId": "f6e24ebdaf64ef91adb0b60e3b582db0",
    "did": "85235753351"
  }
}