Skip to content

PNS API query extension

henryou edited this page May 14, 2024 · 2 revisions

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

请求url

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

请求头

参数名 类型 必填 说明 示例值
accessKey string 用户的accessKey fme2na3kdi3ki
action string 请求方法 queryAXB
bizType string 业务类型,固定为5,代表隐私号服务 5
ts string 毫秒级时间戳,示例:1670479632933 1655710885431
sign string 签名,签名算法

请求体

参数名 类型 必填 说明
caller string 主叫号码,允许不带国码
did string did号码(中间号码X),必须要带国码
extension string 分机号码

返回参数

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

data的数据结构如下:

参数名 类型 说明
callee string 被叫
callId string 通话ID
extension string 分机号
flag uint 其他标识,比特组合,0:none,1:录音
audioWhenCallFail string 若是ret_code!=0且audio_when_call_fail非空,则播放此音频文件,其格式是wav格式

请求示例

请求url

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

Header

KEY VALUE
accessKey xxxxxxxxxxxx
ts 1670479632933
bizType 5
action queryAXB
sign faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4

Body

{
    "caller": "85222222222",
    "did": "85235753352",
    "extension": "111"
}

返回示例

{
    "code": 0,
    "msg": "success",
    "requestId": "1602233475628404736",
    "data": {
        "callee": "85211111114",
        "callId": "1602233475636793344",
        "flag": 0,
        "audioWhenCallFail": ""
    }
}

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent(对外api)

Clone this wiki locally