PNS BIND AXB - nxtele/http-api-document GitHub Wiki

接口说明: 绑定axb模式

概述:

  • 平台为主叫号码a和被叫号码b绑定一个隐私号码x,a和b之间的通信都是通过隐私号x进行转接,从而隐藏被叫号码a和主叫号码b的真实号码
  • 适用场景: 网约车出行、快递外卖、o2o服务等

请求方式

  • URL: https://api.nxcloud.com/v1/pns/bind/axb
  • Method: POST
  • Content-Type: application/json
  • 是否需要鉴权:

鉴权机制

请求参数说明

  • Header参数

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

参数名 必填 类型 说明
businessId string 应用key
phoneA string A的号码,号码格式:需要带国码前缀
phoneB string B的号码,号码格式:需要带国码前缀
bindExpireSecond int 绑定关系的过期时间(单位秒),默认7200s
didX string 预期绑定的X号码,有值时选择固定DID,无值时随机选择DID
customerBindId string 客户自定义的绑定id(由客户决定,需要保证唯一,系统会根据该字段做幂等),可为空
recording boolean 是否录音,默认false
ext string 自定义字段,会在话单时透传
iso2X string didX的iso2, 当didX没有传时,该值可以指定didX的方向

返回参数说明

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

data返回参数详情:

参数名 类型 说明
bindId string 绑定id
didX string 绑定的x号码

请求示例

  • CURL 格式
curl --location --request POST 'https://api.nxcloud.com/v1/pns/bind/axb' \
--header 'action: bindAxb' \
--header 'bizType: 5' \
--header 'accessKey: yyds' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'ts: 1728359394964' \
--header 'sign: d73f48559784e6c8b8c54ec9aa85bc1b' \
--data-raw '{
    "phoneA": "85213215564",
    "phoneB": "85254648795",
    "bindExpireSecond": 300,
    "ext": "it is ext",
    "recording": true
}'

返回示例

{
    "code": 0,
    "msg": "success",
    "requestId": "1843499034666340352",
    "data": {
        "bindId": "75a1a571f98a2b24505fbfa14aba87a6",
        "didX": "8521313564"
    }
}