Skip to content

PNS API bind

henryou edited this page May 14, 2024 · 6 revisions

接口说明,提交A、B两个号码进行绑定,返回一个X号码

请求url

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

请求头

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

请求体

参数名 必填 类型 说明
phoneA string A的号码,A、B号码的国码须保持一致
phoneB string B的号码,A、B号码的国码须保持一致
phoneX string 预期绑定的X号码,须与A、B号码的国码保持一致,有值时选择固定DID,无值时随机选择DID
customerBindId string 客户自定义的绑定id(由客户决定,需要保证唯一),可为空
flag int 其他标识,比特组合,0:none,1:录音
expireSecond int 过期秒数,若是为0,代表不过期

返回参数

参数名 类型 说明
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 bindAXB
sign faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4

Body

{
    "phoneA": "85211111114",
    "phoneB": "85222222222",
    "customerBindId": "1",
    "expireSecond": 1011
}

返回示例

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

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent(对外api)

Clone this wiki locally