-
Notifications
You must be signed in to change notification settings - Fork 6
PNS API bind axyb
justin4515 edited this page Aug 2, 2024
·
6 revisions
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模式时有值。 |
https://api.nxcloud.com/v1/api/pns/
KEY | VALUE |
---|---|
accessKey | sixxxxxxxxxxxv4 |
ts | 1670479632933 |
bizType | 5 |
action | bindAXYB |
sign | faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4 |
{
"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": ""
}
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent(对外api)