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

接口说明: 绑定axeyb模式

概述

  • 与axyb的区别在于主叫号码a拨打虚拟号码x需要输入分机号e进行转接。能提高隐私号x号码的利用率。但a呼x会额外产生输入分机号e这段时间的通话时长。
  • 适用场景: 外卖、快递场景

请求方式

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

鉴权机制

请求参数说明

  • Header参数

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

  • Body 参数

参数名 必填 类型 说明
businessId 是 string 应用key
phoneB 是 string B的号码，号码格式:需要带国码前缀
bindExpireSecond 是 int 过期秒数，默认7200s
phoneA 否 string A的号码，号码格式:需要带国码前缀
didX 否 string 预期绑定的X号码，有值时选择固定DID，无值时随机选择DID
didY 否 string 预期绑定的Y号码，有值时选择固定DID，无值时随机选择DID
customerBindId 否 string 客户自定义的绑定id（由客户决定，需要保证唯一），可为空
recording 否 boolean 其他标识,默认false
delayedGetY 否 boolean 延迟分配y号码,默认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号码
extensionX string x号码的分机号(4位)

请求示例

  • CURL 格式
curl --location --request POST 'https://api.nxcloud.com/v1/pns/bind/axeyb' \
--header 'action: bindAXEYB' \
--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": "75a1a571f98a2b24505fbfa14aba8789",
        "didX": "8521313564",
        "didY": "8521465462",
        "extensionX": "0191"
    }
}