Skip to content

PNS API bind axyb

justin4515 edited this page Aug 2, 2024 · 6 revisions

接口参数

请求url

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

请求头

参数名 类型 必填 说明 示例值
accessKey string 用户的accessKey fxxxxxxxxxi
action string 请求方法 bindAXYB
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
phoneY string 预期绑定的Y号码,须与A、B号码的国码保持一致,有值时选择固定DID,无值时随机选择DID
extensionX string 分机号,在拨打X时输入,位数4位,不输入时,随机分配
customerBindId string 客户自定义的绑定id(由客户决定,需要保证唯一),可为空
flag int 录音标识,0:不录音,1:录音
expireSecond int 秒级时间戳,过期秒数,若是为0,代表不过期
pnsType string 标识绑定类型,AXYB模式的请输入"axyb",AXEYB模式请输入"axeyb"
isNeedPhoneYInXEYB int 用于指定生成关系时是否需要Y号。在axeyb模式时可使用,可选值为0-需要Y,1-不需要Y。默认值为0。
bindExpireSecond int api绑定阶段的过期时间,单位秒
expireStrategy int 过期时间策略,可选值0-默认,1-重置,2-顺延
callInExpireSecond int 呼入绑定阶段的过期时间,单位秒
ext string 自定义字段,最大长度为1024

返回参数

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

data返回参数详情:

参数名 类型 说明
bindId string pns的绑定id,后续计费都会基于此
didX string pns的绑定虚拟号码X
didY string pns的绑定虚拟号码Y
extensionX string 绑定AXYEB时自动分配的分机号,axeyb模式时有值。

请求示例

请求url

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

Header

KEY VALUE
accessKey sixxxxxxxxxxxv4
ts 1670479632933
bizType 5
action bindAXYB
sign faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4

Body

{
    "phoneA": "852xxxxxxxx14",
    "phoneB": "852xxxxxxxx22",
    "customerBindId": "1",
    "expireSecond": 1000,
    "flag": 1,
    "pnsType": "axyb"
}

返回示例

{
  "code": 0,
  "msg": "success",
  "requestId": "1602XXXXXXXXXXXXX9504",
  "data": {
    "bindId": "SWXXXXXXXXXXXXXXXXXXX2db0",
    "didX": "852XXXXXXX51",
    "didY": "852XXXXXXX21",
    "extensionX": ""
  }
}

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent(对外api)

Clone this wiki locally