-
Notifications
You must be signed in to change notification settings - Fork 6
Number Check API callback old
GiuFLim edited this page Sep 18, 2023
·
1 revision
- 检测结果推送
- 通过提交检测API的drUrl字段指定,或者在NXCLOUD平台配置
- Method: POST
- Content-Type: application/json
一般情况下,检测结果将在10秒-5分钟内推送回指定的API地址。收到HTTP 200 OK代表已接受NXCLOUD的回执推送,NXCLOUD将本次请求视为已完成。 如果收到HTTP ERROR信息,NXCLOUD将在60分钟内,每分钟重试推送。直到成功为止,如果超过60分钟仍然失败,则不再重复推送。
基础版
{
"messageId": "83ac9512-3c47-495d-a3c4-6d77a9f1149c",
"code": 0,
"msg": "success",
"batchNo": "700337042751",
"phone": "234800001xxxxx",
"data": {
"basic": {
"preCheck": "YES",
"regionCode": "CN",
"countryCode": "86",
"nationalNumber": "800001xxxxx",
"standNumber": "234800001xxxxx",
"numberType": 2,
"carrier": "China Telecom"
}
},
"cost": {
"price": 0.1912,
"currency": "USD"
}
}
HLR检测
{
"messageId": "83ac9512-3c47-495d-a3c4-6d77a9f1149c",
"code": 0,
"msg": "success",
"batchNo": "700337042751",
"phone":"234800001xxxxx",
"data": {
"basic": {
"preCheck": "YES",
"regionCode": "CN",
"countryCode": "86",
"nationalNumber": "800001xxxxx",
"standNumber": "234800001xxxxx",
"numberType": 2,
"carrier": "China Telecom"
},
"live": {
"validity": "YES",
"reachable": "UNKNOWN",
"roaming": "UNKNOWN"
}
},
"cost": {
"price": 0.9230,
"currency": "USD"
}
}
呼叫版
{
"messageId": "83ac9512-3c47-495d-a3c4-6d77a9f1149c",
"code": 0,
"msg": "success",
"batchNo": "700337042751",
"phone": "234800001xxxxx",
"data": {
"basic": {
"preCheck": "YES",
"regionCode": "CN",
"countryCode": "86",
"nationalNumber": "800001xxxxx",
"standNumber": "234800001xxxxx",
"numberType": 2,
"carrier": "China Telecom"
},
"dial": {
"early": "NO",
"answered": "NO",
"response": "invalid_number"
}
},
"cost": {
"price": 1.0231,
"currency": "USD"
}
}
检测失败
{
"messageId": "cc5ef7d6-62be-42c9-abdf-b6ea9d6ed5e6",
"code": 114,
"msg": "号码格式有误",
"batchNo": "700337042751",
"phone":"18617"
}
回执结果说明
参数名 | 类型 | 说明 |
---|---|---|
messageId | string | 消息id 最大长度为64位 |
code | integer | code=0表示成功 |
msg | string | 返回结果说明 |
batchNo | string | 批次号 |
phone | string | 手机号 |
basic | object | 基础版信息,结构见下方说明 |
live | object | 高级版信息,结构见下方说明 |
dial | object | 呼叫版信息,结构见下方说明 |
cost | object | 费用信息,结构见下方说明 |
basic
参数名 | 类型 | 说明 |
---|---|---|
preCheck | string | 格式检查是否通过。 YES:通过; NO:未通过 |
regionCode | string | 区号 iso |
countryCode | string | 国码 |
nationalNumber | string | 本地格式 |
standNumber | string | 标准格式 |
numberType | integer | 号码类型。 0: 其它类型 1: 固定电话 2: 移动号码 3: 免费电话 4: VOIP号码 5: 机构/企业电话 6: 特殊私人号码 7: 语音信箱 8: 特殊限制号码 |
carrier | string | 运营商 |
live
参数名 | 类型 | 说明 |
---|---|---|
validity | string | 号码是否有效。 "YES": 是; "NO": 否; "UNKNOWN": 未知 |
reachable | string | 设备是否在线。 "YES": 是; "NO": 否; "UNKNOWN": 未知 |
roaming | string | 是否漫游中。 "YES": 是; "NO": 否; "UNKNOWN": 未知 |
dial
参数名 | 类型 | 说明 |
---|---|---|
early | string | 是否响铃 "YES": 是; "NO": 否; "UNKNOWN": 未知 |
answered | string | 是否接听 "YES": 是; "NO": 否; "UNKNOWN": 未知 |
response | string | 响应状态。 bell: 响铃 music: 彩铃 busy: 用户忙 no_response: 用户无应答 invalid_number: 空号 not_available: 号码不可用 number_paused: 暂停使用 power_off: 关机 power_off_or_out_of_service: 关机或不在服务区 voicemail: 语音信箱 others: 暂时无法接通 |
cost
参数名 | 类型 | 说明 |
---|---|---|
price | number | 费用。精确到四位小数 |
currency | string | 币种 |
回执错误代码
code | msg |
---|---|
0 | 成功 |
103 | 内部服务器错误 |
108 | 请求的值不合法 |
112 | 后端服务调用失败 |
114 | 号码格式有误 |
120 | 不支持非移动号码检测 |
121 | 未知错误 |
122 | 无法检测到信息 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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)