-
Notifications
You must be signed in to change notification settings - Fork 5
callback
GiuFLim edited this page Apr 16, 2026
·
1 revision
通过 API 查询 WhatsApp 回调落库记录
- URL:
https://api2.nxcloud.com/api/wa/callback - Method:
POST - Content-Type:
application/json - 需要鉴权:是
鉴权规则参考:API接口调用约定
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| accessKey | String | 是 | fme2na3kdi3ki |
用户身份标识 |
| ts | String | 是 | 1776221463135 |
毫秒时间戳,允许误差 60 秒 |
| bizType | String | 是 | 2 |
WhatsApp 业务固定值 |
| action | String | 是 | mt |
WA 鉴权动作(需符合鉴权规则) |
| sign | String | 是 | 6e9506557d1f289501d333ee2c365826 |
请求签名 |
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| appkey | String | 是 | pem28kje |
应用 appkey |
| messaging_product | String | 是 | whatsapp |
固定值 |
| business_phone | String | 是 | xxx |
商户号码 |
| field | String | 是 | account_update |
回调事件类型 |
| start_ime | String | 是 | 2026-04-16 00:00:00 |
开始时间,格式 yyyy-MM-dd HH:mm:ss
|
| end_time | String | 是 | 2026-04-16 23:59:59 |
结束时间,格式 yyyy-MM-dd HH:mm:ss
|
smb_app_state_syncsmb_message_echoeshistoryaccount_update
start_ime <= end_time- 时间窗口需在最近 7 天范围内
{
"appkey": "pem28kje",
"messaging_product": "whatsapp",
"business_phone": "xxx",
"field": "account_update",
"start_ime": "2026-04-16 00:00:00",
"end_time": "2026-04-16 23:59:59"
}| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 结果码 |
| message | String | 结果说明 |
| data | Array | 回调原始 content 列表(JSON 字符串) |
回执内容具体含义参考文档 https://www.nxcloud.com/document/whats-app/webhook
{
"code": 0,
"data": [
"{\"field\":\"account_update\",\"value\":{\"wabaId\":\"xxx\",\"business_phone\":\"xxx\",\"waba_info\":{\"owner_business_id\":\"xxx\",\"waba_id\":\"xxx\"},\"time\":1775634505,\"event\":\"PARTNER_ADDED\"}}",
"{\"field\":\"account_update\",\"value\":{\"wabaId\":\"xxx\",\"business_phone\":\"xxx\",\"waba_info\":{\"owner_business_id\":\"xxx\",\"waba_id\":\"xxx\"},\"time\":1775634505,\"event\":\"PARTNER_REMOVED\"}}"
],
"message": "success"
}回执内容具体含义参考文档 https://www.nxcloud.com/document/wa-gl/smb
{
"code": 0,
"data": [
"{\"field\":\"history\",\"value\":{\"wabaId\":\"xxx\",\"business_phone\":\"xxx\",\"metadata\":{\"phone_number_id\":\"xxx\",\"display_phone_number\":\"xxx\"},\"messaging_product\":\"whatsapp\",\"messages\":[{\"image\":{\"sha256\":\"T8FaYFvXheFg2ttkUKd09bcp6IcDjVttSlFlKz9NsN8=\",\"mime_type\":\"image/jpeg\",\"id\":\"1307616347910608\",\"url\":\"https://lookaside.fbsbx.com/whatsapp_business/attachments/?mid=1307616347910608&source=webhook&ext=1775095139&hash=ARkbuGqYGg7rvpp6OJcvtg0KxLXJlXhyR4326efsT49Hjw\"},\"from\":\"xxx\",\"id\":\"wamid.HBgNODYxMzUzMjQwNzA0MRUCABIYIEE1RUNENTRFRkMyMEUyQTIzMkY4Qzc3RTM4NDVDRDJGAA==\",\"type\":\"image\",\"timestamp\":\"1775024747\"}]}}"
],
"message": "success"
}回执内容具体含义参考文档 https://www.nxcloud.com/document/wa-gl/smb
{
"code": 0,
"data": [
"{\"field\":\"smb_app_state_sync\",\"value\":{\"wabaId\":\"xxx\",\"business_phone\":\"xxx\",\"metadata\":{\"phone_number_id\":\"xxx\",\"display_phone_number\":\"xxx\"},\"state_sync\":[{\"metadata\":{\"timestamp\":\"0\"},\"contact\":{\"phone_number\":\"xxx\"},\"action\":\"remove\",\"type\":\"contact\"},{\"metadata\":{\"timestamp\":\"0\"},\"contact\":{\"phone_number\":\"xxx\"},\"action\":\"remove\",\"type\":\"contact\"}],\"messaging_product\":\"whatsapp\"}}"
],
"message": "success"
}回执内容具体含义参考文档 https://www.nxcloud.com/document/wa-gl/smb
{
"code": 0,
"data": [
"{\"field\":\"smb_message_echoes\",\"value\":{\"message_echoes\":[{\"from\":\"xxx\",\"to\":\"xxx\",\"id\":\"wamid.HBgLODUyMzg1MzM4NTkVAgARGBQzQkUwRUQzMkQ2N0UyMjczREIzNwA=\",\"text\":{\"body\":\"434\"},\"type\":\"text\",\"timestamp\":\"1776233682\"}],\"wabaId\":\"xxx\",\"business_phone\":\"xxx\",\"metadata\":{\"phone_number_id\":\"xxx\",\"display_phone_number\":\"xxx\"},\"messaging_product\":\"whatsapp\",\"contacts\":[{\"user_id\":\"CN.1168301782009975\",\"wa_id\":\"xxx\"}]}}"
],
"message": "success"
}{
"code": 9000,
"message": "参数异常(field不能为空)",
"data": null
}{
"code": -1,
"message": "appkey:xxx不存在",
"data": null
}{
"code": 10003,
"message": "WhatsApp business phone is not bind app",
"data": null
}| code | message | 说明 |
|---|---|---|
| 0 | success | 成功 |
| -1 | failure | 业务失败(如 appkey 不存在) |
| 9000 | Request parameter error | 参数错误 |
| 9002 | Phone number error | 商户号码不存在或不可用 |
| 10003 | WhatsApp business phone is not bind app | 商户号不属于当前鉴权客户 |
| 1000~100X | Authentication failed | 鉴权失败(详见鉴权文档) |
-
messaging_product必须传whatsapp。 -
时间格式必须是
yyyy-MM-dd HH:mm:ss。 -
field仅支持上述 4 个值。 -
该接口返回的是回调原文字符串数组,客户端需要自行反序列化。
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
- 二维码管理
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使用说明
NXLINK(HKG)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(IDN)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
NXLINK(CHL)
- 发送WhatsApp消息
- webhook
- 发送Viber消息
- webhook-viber
- 发送Line消息
- webhook-Line
- 批量创建客户
- 批量创建客户sea
- 查询客户字段接口
- 查询、创建模板相关接口
- 查询对话分析相关接口
- 查询通知分析相关接口
- 查询聊天记录接口
- 查询客户列表
AI Agent
RCS