-
Notifications
You must be signed in to change notification settings - Fork 6
PNS API list
henryou edited this page May 14, 2024
·
6 revisions
https://api.nxcloud.com/v1/api/pns/
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
accessKey | string | 是 | 用户的accessKey |
action | string | 是 | 请求方法,示例:getAXBList |
bizType | string | 是 | 业务类型,固定为5,代表隐私号服务 |
ts | string | 是 | 毫秒级时间戳,示例:1670479632933 |
sign | string | 是 | 签名,签名算法 |
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
limit | uint | 是 | 取值范围[0,1k],0代表不限制(获取所有),最大只允许获取1k条数据,关于=0时候超过1k条的问题,只会返回1k条 |
offset | uint | 是 | 偏移值,取值范围为[0,MAX],0代表从第一条开始 |
参数名 | 类型 | 说明 |
---|---|---|
code | int | 返回码,0代表成功,其他失败 |
msg | string | 返回码描述 |
requestId | string | 请求id |
data | Object | 请求数据 |
data返回参数详情:
参数名 | 类型 | 说明 |
---|---|---|
bindList | []Object | 返回绑定列表 |
total | int | 返回绑定关系数 |
bind_list中返回参数详情:
参数名 | 类型 | 说明 |
---|---|---|
customerId | string | 客户id |
businessId | string | 业务id(比如这个did集合是做打车的,做快递的等等) |
bindId | string | 绑定时候,隐私号服务返回的绑定id |
customerBindId | string | 客户自定义的绑定id(由客户决定,需要保证唯一,customerBindId和bindId二选一即可) |
phoneA | string | A的号码 |
phoneB | string | B的号码,A、B号码的国码须保持一致 |
did | string | pns的绑定虚拟号码 |
flag | int | 其他标识,比特组合,0:none,1:录音 |
expireAt | uint | 过期秒数,若是为0,代表不过期 |
extension | string | 仅用于分机号功能, |
https://api.nxcloud.com/v1/api/pns/
KEY | VALUE |
---|---|
accessKey | xxxxxxxxxxxx |
ts | 1670479632933 |
bizType | 5 |
action | getAXBList |
sign | faxxxxxxxxxxxxxxxxxxxxxxxxxxxxd4 |
{
"limit":10,
"offset":0
}
{
"code": 0,
"msg": "success",
"requestId": "1602262837283131392",
"data": {
"bindList": [
{
"customerId": "cus_1",
"businessId": "busi_1",
"bindId": "b8c2aaf940d534d3c9ed8b780757f94e",
"customerBindId": "1",
"phoneA": "85211111114",
"phoneB": "85222222222",
"did": "85235753352",
"flag": 0,
"expireAt": 1670845212,
"extension": "101"
}
],
"total": 1
}
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- 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