Skip to content

PNS BIND AXYB

justin4515 edited this page Oct 8, 2024 · 11 revisions

接口说明: 绑定axyb模式

请求方式

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

鉴权机制

请求参数说明

  • Header参数

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

参数名 必填 类型 说明
phoneA string A的号码,A、B号码的国码须保持一致
phoneB string B的号码,A、B号码的国码须保持一致
didX string 预期绑定的X号码,须与A、B号码的国码保持一致,有值时选择固定DID,无值时随机选择DID
didY string 预期绑定的y号码,须与A、B号码的国码保持一致,有值时选择固定DID,无值时随机选择DID
customerBindId string 客户自定义的绑定id(由客户决定,需要保证唯一)
delayedGetY boolean 延迟分配y号码,默认false
businessId string 业务id
recoding int 其他标识,比特组合,0:不录音,1:录音;默认值为0
bindExpireSecond int 过期秒数
ext string 自定义字段,会在话单时透传

返回参数说明

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

data返回参数详情:

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

请求示例

  • CURL 格式
curl --location --request POST 'https://api.nxcloud.com/v1/pns/bind/axyb' \
--header 'action: bindAXYB' \
--header 'bizType: 5' \
--header 'accessKey: yyds' \
--header 'Content-Type: application/json' \
--header 'ts: 1728367890316' \
--header 'sign: af40432dffba76f4e5f528238242db86' \
--data-raw '{
    "phoneA": "85254987987",
    "phoneB": "85264654798",
    "bindExpireSecond": 300,
    "customerBindId": "fertertrytry89798798dsfs97dfsdf",
    "ext": "it is ext",
    "recording": false
}'

返回示例

{
    "code": 0,
    "msg": "success",
    "requestId": "1843534666482585600",
    "data": {
        "bindId": "26105f52c8d92c1f4646f078c4f1b300",
        "didX": "8521321654",
        "didY": "8521321655"
    }
}

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally