Skip to content

callback

GiuFLim edited this page Apr 16, 2026 · 1 revision

查询回调记录(callback)

通过 API 查询 WhatsApp 回调落库记录

  • URL:https://api2.nxcloud.com/api/wa/callback
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:是

鉴权机制

鉴权规则参考:API接口调用约定

Header 参数

参数名 类型 必选 示例值 说明
accessKey String fme2na3kdi3ki 用户身份标识
ts String 1776221463135 毫秒时间戳,允许误差 60 秒
bizType String 2 WhatsApp 业务固定值
action String mt WA 鉴权动作(需符合鉴权规则)
sign String 6e9506557d1f289501d333ee2c365826 请求签名

请求参数(Body)

参数名 类型 必选 示例值 说明
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

field 支持值(忽略大小写)

  • smb_app_state_sync
  • smb_message_echoes
  • history
  • account_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 字符串)

响应示例

account_update 成功

回执内容具体含义参考文档 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"
}

history 成功

回执内容具体含义参考文档 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"
}

smb_app_state_sync 成功

回执内容具体含义参考文档 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"
}

smb_message_echoes 成功

回执内容具体含义参考文档 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
}

失败示例:appkey 不存在

{
  "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 鉴权失败(详见鉴权文档)

对接注意事项

  1. messaging_product 必须传 whatsapp

  2. 时间格式必须是 yyyy-MM-dd HH:mm:ss

  3. field 仅支持上述 4 个值。

  4. 该接口返回的是回调原文字符串数组,客户端需要自行反序列化。

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

NXLINK(HKG)

NXLINK(IDN)

NXLINK(CHL)

AI Agent

RCS

Clone this wiki locally