-
Notifications
You must be signed in to change notification settings - Fork 6
SMB_zh
GiuFLim edited this page Dec 30, 2025
·
3 revisions
您可以配置嵌入式注册,以允许业务客户使用现有的 WhatsApp Business 应用账户和电话号码接入。选择此选项后成功接入的客户将能够使用您的应用向其客户大规模发送消息,同时仍可通过 WhatsApp Business 应用一对一发送消息,且两个应用之间的消息记录保持同步。
- 个人号的历史联系人数据同步 smb_app_state_sync
- 个人号与联系人之间的历史聊天记录同步 history
- 个人号通过WhatsApp设备发送的消息,消息镜像同步 smb_message_echoes
描述业务客户的 WhatsApp Business 应用中的一个或多个 WhatsApp 联系人。
- 解决方案提供方同步某业务客户的 WhatsApp 联系人,该业务客户已通过 WhatsApp Business 应用电话号码完成接入
- 由解决方案提供方接入、使用 WhatsApp Business 应用电话号码的业务客户添加、编辑或移除 WhatsApp 联系人
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | 业务客户的 WhatsApp Business 业务账户编号 | 102290129340398 |
| business_phone String | 业务客户的公司电话号码。 | 15550783881 |
| phone_number_id String | 业务客户的业务电话号码编号。 | 106540352242922 |
| full_name String | 联系人的全名,与业务客户的 WhatsApp Business 应用电话号码通讯录中显示的全名一致。如果业务客户从其 WhatsApp Business 应用电话号码通讯录中移除了联系人,则不包含此字段。 | Pablo Morales |
| phone_number String | 联系人的 WhatsApp 电话号码。 | 16505551234 |
| action String | 表示业务客户是否在其 WhatsApp Business 应用电话号码通讯录中添加、编辑或删除了联系人。值可以是:add — 商家添加或编辑了联系人。remove — 商家移除了联系人 | add |
| timestamp String | Unix 时间戳,表示添加、编辑或移除联系人的时间。 | 1738346006 |
{
"field": "smb_app_state_sync",
"value": {
"business_phone": "xxx",
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"state_sync": [
{
"type": "contact",
"contact": {
"full_name": "xxx",
"phone_number": "628786xxx78"
},
"action": "add",
"metadata": {
"timestamp": "1756977333478"
}
},
{
"type": "contact",
"contact": {
"full_name": "xxx",
"phone_number": "861332xxx7446"
},
"action": "add",
"metadata": {
"timestamp": "1756977333478"
}
},
{
"type": "contact",
"contact": {
"full_name": "\u202a+852xxx3859\u202c",
"phone_number": "85238xxx859"
},
"action": "add",
"metadata": {
"timestamp": "1756977333478"
}
},
{
"type": "contact",
"contact": {
"full_name": "\u202a+551xxx65\u202c",
"phone_number": "551xxxx2065"
},
"action": "add",
"metadata": {
"timestamp": "1756977333478"
}
}
],
"wabaId": "xxx"
}
}描述已选择与解决方案提供方共享聊天记录的商家的 WhatsApp Business 应用聊天记录,或商家拒绝共享聊天记录的决定。
- 解决方案提供方同步某业务客户的 WhatsApp Business 应用聊天记录,该业务客户已通过 WhatsApp Business 应用电话号码完成接入,且已同意共享其聊天记录
- 解决方案提供方同步某业务客户的 WhatsApp Business 应用聊天记录,该业务客户已通过 WhatsApp Business 应用电话号码完成接入,但拒绝共享其聊天记录
如果在解决方案提供方请求商家聊天记录时,商家已批准共享聊天记录,则会触发一系列历史记录 Webhook,其中描述自商家接入云端 API 后 180 天内发送或接收的所有消息。
- 群聊中的消息不会包含在内
- 媒体消息将不包含素材编号;但是,将单独发送包含媒体消息素材编号的其他历史记录 Webhook,但仅限于接入后 14 天内发送的媒体消息
请注意,为提高效率,单个 Webhook 可能描述上千条消息,因此我们建议您先获取其内容,然后异步处理内容。
Webhook 分为三个历史阶段,其中第 0 天表示商家接入云端 API 的时间:
- 阶段 0:第 0 天到第 1 天
- 第 1 阶段:第 1 天到第 90 天
- 第 2 阶段:第 90 天到第 180 天
对于每个阶段,聊天记录 Webhook 可能会拆分成多个独立的块发送,具体取决于对话中消息的总数。
- 您可以使用
chunk_order参数值按顺序排列这些块,因为它们可能并非按顺序送达。 - 您可以使用
phase参数值来监控阶段进度。值2表示当前阶段已完成。 - 您可以使用
progress参数值来监控整体进度。值100表示同步已完成。
如果某个阶段没有可用的聊天记录,则不会发送相应的 Webhook。
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | 业务客户的 WhatsApp Business 业务账户编号。 | 102290129340398 |
| business_phone String | 业务客户的公司电话号码 | 15550783881 |
| phone_number_id String | 业务客户的业务电话号码编号。 | 106540352242922 |
| phase Integer | 表示历史记录阶段。值可以是: 0 — 表示消息来自第 0 天(商家接入时间)到第 1 天 1 — 表示消息来自第 1 天到第 90 天 2 — 表示消息来自第 90 天到第 180 天 |
1 |
| chunk_order Integer | 表示块编号,可用于对一系列 Webhook 进行排序。 | 1 |
| progress Integer | 表示同步进度的总百分比。最小值为 0,最大值为 100。 | 55 |
| id String | WhatsApp 消息编号。 | wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0N0FCNjMA |
| timestamp String | Unix 时间戳,表示收信人设备收到消息的时间。 | 1738796547 |
| type String | 消息类型。请注意,此占位符在以上语法中出现了两次,因为它同时被用作 type 属性值及其匹配属性名称的占位符。请参阅下方的 Payload 示例,以查看包含各种消息类型的对话。 如果此值设为 media_placeholder,则消息对象描述包含素材的消息。在这种情况下,消息内容将被忽略。取而代之,后续会发送一个单独的历史记录 Webhook,其中描述消息内容和素材编号,但仅针对查询前两周内发送的消息。请参阅下方描述媒体消息内容的 Payload 示例。 |
text |
| content Object | 描述消息内容的对象。此值根据消息类型和消息内容而有所不同。例如,如果商家发送不带说明的 image 消息,该对象将不包含 caption 属性。 | {"body":"Here's the info you requested! https://www.meta.com/quest/quest-3/"} |
| status String | 表示消息的最新送达统计数据。值可以是:DELIVERED ,ERROR,PENDING,PLAYED,READ,SENT | READ |
{
"field": "history",
"value": {
"business_phone": "xxx",
"history": [
{
"metadata": {
"phase": 0,
"chunk_order": 1,
"progress": 100
},
"threads": [
{
"id": "447xxx736",
"messages": [
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSRDExQTYyMjc0RjVDNTlBOENBAA==",
"timestamp": "1756977261",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSMDMyNTU5RTlGQjY5NEIxQUI2AA==",
"timestamp": "1756956364",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSQTE4QTg0MTU2MkQ1QzlDQThEAA==",
"timestamp": "1756889400",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSNDY2MUE2RjdGQTYzMTAyMDI4AA==",
"timestamp": "1756709184",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSRjk1QkJFREU4OURBMzlFMEFBAA==",
"timestamp": "1756709077",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSNTQyMzRDNUZCMTNFNkQyM0Q1AA==",
"timestamp": "1754298556",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSRDMzMkM5RkIwNDI4QjQ5MjI5AA==",
"timestamp": "1754298510",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSMjczNzMyM0ZEOUVFQkZDREE4AA==",
"timestamp": "1754298423",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSOTIyM0E5RjY0M0Y2REIzNkE0AA==",
"timestamp": "1754297908",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "447xxx736",
"id": "wamid.HBgMNDQ3NzEwMTczNzM2FQIAEhgSOEQzNDQ1QjQxRTU2NjBENTI4AA==",
"timestamp": "1754279571",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
}
]
},
{
"id": "86133xxx446",
"messages": [
{
"from": "86133xxx446",
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABIYFDNBNkIwNDdFRDNCRTNGODQyM0JDAA==",
"timestamp": "1756958075",
"text": {
"body": "364"
},
"type": "text",
"history_context": {
"status": "pending"
}
},
{
"from": "551xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYEjlDQkQyMDgyNDRDM0VDQ0RGMgA=",
"timestamp": "1756718044",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "read",
"from_me": true
}
},
{
"from": "551xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFjNFQjBBMEMwMDc3MDY2MTE3OTZBM0EA",
"timestamp": "1756717440",
"text": {
"body": "1234567890"
},
"type": "text",
"history_context": {
"status": "read",
"from_me": true
}
},
{
"from": "8613xxx446",
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABIYFDNBRTM4NDU0RDZFNDVERENFM0Y4AA==",
"timestamp": "1756717325",
"text": {
"body": "3q"
},
"type": "text",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx66",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBOUMyQURGMDk3Q0I1RTBFNzBDAA==",
"timestamp": "1756716515",
"text": {
"body": "Hello hi"
},
"type": "text",
"history_context": {
"status": "read",
"from_me": true
}
},
{
"from": "8613xxx446",
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABIYFDNBMThEOUZEQjFBOTkwMUE3MzhDAA==",
"timestamp": "1756714179",
"text": {
"body": "Happy beginning"
},
"type": "text",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYEjI1NUNFQTRBNkIwMkE4QkY3RQA=",
"timestamp": "1756710767",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "read",
"from_me": true
}
},
{
"from": "8613xxx446",
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABIYIEQxRkJFRDVGMTA2QTlFNjYxRjdFNDgwQTJBMjgyNzY0AA==",
"timestamp": "1756710061",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBQjAwNzI3QkVCOTFEOTUyMTVDAA==",
"timestamp": "1756709332",
"text": {
"body": "苍龙"
},
"type": "text",
"history_context": {
"status": "read",
"from_me": true
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBREI5MjY5RTgwNkQ1QTI2RThFAA==",
"timestamp": "1752719536",
"text": {
"body": "123456789"
},
"type": "text",
"history_context": {
"status": "delivered",
"from_me": true
}
}
]
},
{
"id": "628xxx678",
"messages": [
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYIEI2RDgyNUVENTcxMTExMjUyRUJDOUQ1NURFNjgzRjgxAA==",
"timestamp": "1755764541",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending",
"from_me": true
}
}
]
},
{
"id": "5512xxx065",
"messages": [
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBRTMxMTdBOTRFQTFERkEwNTE0AA==",
"timestamp": "1752853979",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "delivered",
"from_me": true
}
}
]
},
{
"id": "852xxx859",
"messages": [
{
"from": "852xxx859",
"id": "wamid.HBgLODUyMzg1MzM4NTkVAgASGBIxNjQ4MUZFODZEMzhEMTcwRDkA",
"timestamp": "1752719539",
"text": {
"body": "simon123"
},
"type": "text",
"history_context": {
"status": "pending"
}
}
]
}
]
}
],
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"wabaId": "xxx"
}
}{
"field": "history",
"value": {
"business_phone": "xxx",
"history": [
{
"metadata": {
"phase": 1,
"chunk_order": 1,
"progress": 100
},
"threads": [
{
"id": "6287xxx678",
"messages": [
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYIEJDM0RGMzQyMUU1NkE4Q0FEMEExNEU5OTU3NEIzRURCAA==",
"timestamp": "1755764476",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending",
"from_me": true
}
},
{
"from": "551xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYIEVGRUY0MUIxRkM0NUVEMEYyNzQ0MjQ4Q0IxQTkxQkM2AA==",
"timestamp": "1755761250",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending",
"from_me": true
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYIEM1MjBGN0UyM0U3Qjg4OUUxNTg4M0E3NzdFRjMxMzgxAA==",
"timestamp": "1755761214",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending",
"from_me": true
}
},
{
"from": "6287xxx678",
"id": "wamid.HBgNNjI4Nzg2ODU3MjY3OBUCABIYIDA4MDY1QkVEMDZDODY3NUYwNEZGM0ZEODVCMEQxMTNDAA==",
"timestamp": "1755756176",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "6287xxx78",
"id": "wamid.HBgNNjI4Nzg2ODU3MjY3OBUCABIYIEUxRUUzNTFFNjg3M0FENjBDRDhFODRFRjIzRUM1ODMxAA==",
"timestamp": "1755755684",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYIDNCQUQ4RDZFNzFCM0JGRTk2NEQ2NDgyQkNGN0MwRkIwAA==",
"timestamp": "1755754947",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending",
"from_me": true
}
},
{
"context": {
"from": "6287xxx678",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABIYEjBCMEExMjExMDY1MzQ3NkM0MgA="
},
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBNDAyRjg2MzE0ODQ0QTY5MDA5AA==",
"timestamp": "1755748593",
"type": "interactive",
"interactive": {
"type": "call_permission_reply",
"call_permission_reply": {
"response": "accept",
"expiration_timestamp": 1756353390,
"response_source": "user_action"
}
},
"history_context": {
"status": "delivered",
"from_me": true
}
},
{
"from": "6287xxx678",
"id": "wamid.HBgNNjI4Nzg2ODU3MjY3OBUCABIYEjBCMEExMjExMDY1MzQ3NkM0MgA=",
"timestamp": "1755748586",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBQkU4NERGN0EwQTBERTVEQzc5AA==",
"timestamp": "1755748580",
"text": {
"body": "1"
},
"type": "text",
"history_context": {
"status": "delivered",
"from_me": true
}
}
]
},
{
"id": "5512xxx065",
"messages": [
{
"from": "5512xxx065",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NRUCABIYEjM2MTkzQ0MzRDMwMUI1NTJCNAA=",
"timestamp": "1752830864",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx065",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NRUCABIYEjJDODMyRUU4QzhEMTZGNUZGOAA=",
"timestamp": "1752830695",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx065",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NRUCABIYEjlFQTlGNjY0OTg2OENGOEQyOQA=",
"timestamp": "1752817953",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "5512xxx065",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NRUCABIYEjBCODVFMDZCMzJDNTYyOEM5QQA=",
"timestamp": "1752810227",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "551xxx65",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NRUCABIYEkIzOUFBQTJBNEU4RjUyQUZCRAA=",
"timestamp": "1752809288",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "551xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBQjk2RjdGNkVEMzBGMjZGRDcyAA==",
"timestamp": "1752809278",
"text": {
"body": "Hello"
},
"type": "text",
"history_context": {
"status": "delivered",
"from_me": true
}
}
]
},
{
"id": "852xxx59",
"messages": [
{
"from": "8523xxx59",
"id": "wamid.HBgLODUyMzg1MzM4NTkVAgASGBJBMEU5NDlBQkE1NTJENjZGRDQA",
"timestamp": "1752719505",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "8523xxx59",
"id": "wamid.HBgLODUyMzg1MzM4NTkVAgASGBI4NkFBODM3NDQzRDhDOEM0MjgA",
"timestamp": "1752719505",
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {
"details": "Unsupported message received"
}
}
],
"type": "errors",
"history_context": {
"status": "pending"
}
},
{
"from": "551xxx066",
"id": "wamid.HBgNNTUxMjkyMDAyMjA2NhUCABEYFDNBNTVEQ0RBOTMwNDI5REYyRDIyAA==",
"timestamp": "1752719502",
"text": {
"body": "123456"
},
"type": "text",
"history_context": {
"status": "delivered",
"from_me": true
}
}
]
}
]
}
],
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"wabaId": "xxx"
}
}{
"field": "history",
"value": {
"business_phone": "xxx",
"history": [
{
"metadata": {
"phase": 2,
"chunk_order": 1,
"progress": 100
}
}
],
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"wabaId": "xxx"
}
}描述业务客户通过 WhatsApp Business 应用或支持的配套设备向 WhatsApp 用户发送的消息。
- 业务客户使用 WhatsApp Business 应用或支持的配套设备向 WhatsApp 用户发送消息。
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | 业务客户的 WhatsApp Business 业务账户编号。 | 102290129340398 |
| business_phone String | 业务客户的公司电话号码。 | 15550783881 |
| phone_number_id String | 业务客户的业务电话号码编号。 | 106540352242922 |
| id String | WhatsApp 消息编号。 | wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0N0FCNjMA |
| timestamp String | Unix 时间戳,表示 Webhook 触发的时间。 | 1738796547 |
| type String | 消息类型,请注意,此占位符在以上语法中出现了两次,因为它同时被用作 type 属性值及其匹配属性名称的占位符。 |
text |
| content Object | 描述消息内容的对象。此值根据消息类型和消息内容而有所不同。例如,如果商家发送不带说明的 image 消息,该对象将不包含 caption 属性。 | {"body":"Here's the info you requested! https://www.meta.com/quest/quest-3/"} |
{
"field": "smb_message_echoes",
"value": {
"business_phone": "xxx",
"message_echoes": [
{
"from": "xxx",
"to": "8613xxx446",
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABEYFDNBQ0Q5Qjg3OUZBQkZERTQ4NDIxAA==",
"timestamp": "1756977414",
"text": {
"body": "Testing test"
},
"type": "text"
}
],
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"wabaId": "xxx"
}
}{
"app_id": "6761",
"business_phone": "xxx",
"channel": 2,
"merchant_phone": "xxx",
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"statuses": [
{
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABEYFDNBQ0Q5Qjg3OUZBQkZERTQ4NDIxAA==",
"meta_message_id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABEYFDNBQ0Q5Qjg3OUZBQkZERTQ4NDIxAA==",
"recipient_id": "8613xxx446",
"status": "delivered",
"timestamp": "1756977415"
}
],
"wabaId": "xxx"
}{
"app_id": "6761",
"business_phone": "xxx",
"channel": 2,
"merchant_phone": "xxx",
"messaging_product": "whatsapp",
"metadata": {
"display_phone_number": "xxx",
"phone_number_id": "xxx"
},
"statuses": [
{
"id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABEYFDNBQ0Q5Qjg3OUZBQkZERTQ4NDIxAA==",
"meta_message_id": "wamid.HBgNODYxMzMyMDIzNzQ0NhUCABEYFDNBQ0Q5Qjg3OUZBQkZERTQ4NDIxAA==",
"recipient_id": "861xxx446",
"status": "read",
"timestamp": "1756978757"
}
],
"wabaId": "xxx"
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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使用说明
AI Agent