-
Notifications
You must be signed in to change notification settings - Fork 6
PNS API webhook
justin4515 edited this page Sep 27, 2024
·
13 revisions
- 通话结果推送
- 通过提供URL,给研发人员进行配置
- Method: POST
- Content-Type: application/json
一般情况下,话单信息将在通话结束后推送回指定的地址。收到HTTP 200 OK代表已接受回执推送,本次请求将视为已完成。 如果收到HTTP 非200,NXCLOUD将每隔五分钟重试一次,重试2次仍然失败,则不再重复推送。
{
"bindId": "cfb3d939d1ccbb7d5ae0df2b5908d093",
"customerBindId": "axeyb_axeyb",
"callId": "c70b8863b4fae7d3a186db050f54dfa2",
"caller": "+62895001924553",
"did": "6289500***4551",
"didX": "6289500***4551",
"didY": "6289500***4550",
"extensionX": "0193",
"callee": "6289500***4555",
"pnsType": "axeyb",
"callStatus": "1",
"callStatusMsg": "Call Connected",
"ext": "test_AXEYB",
"legList": [
{
"callType": 1,
"caller": "+6289500***4553",
"callee": "6289500***4550",
"callStartAt": 1727419285,
"callRingAt": 0,
"callAnswerAt": 1727419286,
"callFinishAt": 1727419339,
"duration": 53,
"callRecordFile": "",
"hangupType": 0,
"hangupCause": "NORMAL_CLEARING",
"hangupCode": 16,
"uuid": "feb54df1-d5e3-4b4d-a5b2-196f963071fd",
"ringDuration": 1,
"fsCallStatus": 1,
"fsCallStatusMsg": "Call Connected",
"vosCallId": "a30ce767b63616c6c0268cd54%4034.142.222.91",
"allExtension": "x,2233,0193"
},
{
"callType": 2,
"caller": "6289500***4551",
"callee": "6289500***4555",
"callStartAt": 1727419285,
"callRingAt": 0,
"callAnswerAt": 1727419286,
"callFinishAt": 1727419339,
"duration": 53,
"callRecordFile": "",
"hangupType": 1,
"hangupCause": "NORMAL_CLEARING",
"hangupCode": 16,
"uuid": "fc1edf83-ee17-4ce5-a07d-f4adfbdc8ff2",
"ringDuration": 1,
"fsCallStatus": 1,
"fsCallStatusMsg": "Call Connected",
"vosCallId": "c70b8863b4fae7d3a186db050f54dfa2",
"allExtension": ""
}
]
}
回执结果说明
参数名 | 类型 | 说明 |
---|---|---|
bindId | string | 系统绑定id |
customerBindId | string | 客户绑定id |
callId | string | 呼叫id |
caller | string | 通话双方-主叫号码 |
did | string | did号码(该字段后续会废弃,axb和axeb模式下,可用didX号码) |
didX | string | X号码 |
didY | string | Y号码 |
extensionX | string | AXEYB、NXEYB、AXEB中的E分机号码 |
callee | string | 通话双方-被叫号码 |
pnsType | string | 绑定类型描述,axb;axyb;axeb;axeyb,xyb,nxeyb |
callStatus | string | 通话状态码 |
callStatusMsg | string | 通话状态具体描述 |
ext | string | 客户扩展字段,在绑定时可传入 |
legList | object | 单边通话具体信息 |
legList的具体结构如下:
参数名 | 类型 | 说明 |
---|---|---|
callType | int64 | 呼叫方向,1:呼入,2:呼出 |
caller | string | 该次呼叫的主叫号码 |
callee | string | 该次呼叫的被叫号码 |
callStartAt | int64 | 通话开始时间戳,单位为秒 |
callRingAt | int64 | 通话响铃时间戳,单位为秒 |
callAnswerAt | int64 | 通话接听时间戳,单位为秒 |
callFinishAt | int64 | 通话挂断时间戳,单位为秒 |
duration | int64 | 通话耗时,单位为秒 |
callRecordFile | string | 通话状态录音文件 |
hangupType | int64 | 挂断方 0-主叫挂断,1-被叫挂断 |
hangupCode | int64 | 错误原因的q850描述。参考 https://www.nxcloud.com/document/nxphone/hang-up-explained |
hangupCause | string | 挂断原因。参考 https://www.nxcloud.com/document/nxphone/hang-up-explained |
uuid | string | 通话唯一标识 |
ringDuration | int64 | 响铃时长,单位为秒 |
fsCallStatus | int64 | 通话状态码 |
fsCallStatusMsg | string | 通话状态具体描述 |
vosCallId | string | 账单相关的callId |
allExtension | string | 在有分机号场景下,用户输入的分机号集,多个分机号逗号相隔,x代表在某个收号周期客户未输 |
call_status和call_status_msg的说明如下:
call_status | call_status_msg |
---|---|
1 | 拨打成功 |
2 | 拨打失败 |
3 | 其他 |
4 | 主叫取消 |
5 | 响铃无人接听 |
6 | 被叫忙 |
7 | 用户拒接 |
8 | 线路原因或被叫原因临时不可达 |
9 | 绑定关系不存在 |
10 | 分机号输入错误(三次未输入或输入错误都算分机号输入错误) |
11 | 被叫号码异常 (axb中的b错误,既:没有b) |
12 | y号码耗尽(仅在绑定时y设置为呼入时动态分配的场景会出现) |
13 | x号码耗尽(仅在一条绑定支持多个主叫A呼入的场景会出现) |
14 | 输入分机号时,客户主动放弃或挂断 |
15 | 系统异常 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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)