SMB - nxtele/nxcloud-doc-en GitHub Wiki
SMB
You can configure Embedded Signup to allow business customers to onboard using their existing WhatsApp Business app account and phone number. Customers who are successfully onboarded after choosing this option will then be able to use your app to message their customers at scale, but still have the ability to send messages on a one-to-one basis using the WhatsApp Business app, while keeping messaging history between both apps in sync.
meta document
smb_app_state_sync
Describes one or more WhatsApp contacts in a business customer's WhatsApp Business app.
Trigger events:
- a solution provider synchronizes the WhatsApp contacts of a business customer who they have onboarded with a WhatsApp Business app phone number
- a business customer, onboarded by a solution provider, with a WhatsApp Business app phone number adds, edits, or removes a WhatsApp contacts
Payload contents
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | The business customer's WhatsApp Business Account ID. | 102290129340398 |
| business_phone String | The business customer's business phone number. | 15550783881 |
| phone_number_id String | The business customer's business phone number ID. | 106540352242922 |
| full_name String | The contact's full name, as it appears in the business customer's WhatsApp Business app phone address book.Not included when the business customer removes a contact from their WhatsApp Business app phone address book. | Pablo Morales |
| phone_number String | The contact's WhatsApp phone number. | 16505551234 |
| action String | Indicates if the business customer added, edited, or deleted a contact from their WhatsApp Business app phone address book. Values can be:add — the business added or edited a contactremove — the business removed a contact |
add |
| timestamp String | Unix timestamp indicated when the contact was added, edited, or removed. | 1738346006 |
webhook
{
"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"
}
}
history
Describes the WhatsApp Business app chat history of a business that has chosen to share their chat history with a solution provider, or the business's decision to decline chat history sharing.
Trigger events
-
a solution provider synchronize the WhatsApp Business app chat history of a business customer who they have onboarded with a WhatsApp Business app phone number, and who has agreed to share their chat history
-
a solution provider synchronize the WhatsApp Business app chat history of a business customer who they have onboarded with a WhatsApp Business app phone number, but the customer has declined to share their chat history
Chat history contents
If the business has already approved chat history sharing when the solution provider requests the business's chat history, a series of history webhooks will be triggered, describing all messages sent or received within 180 days of the time when the business was onboarded onto Cloud API.
- messages that are part of a group chat will not be included
- media messages will not include media asset IDs; instead, additional history webhooks containing media message asset IDs will be sent separately, but only for media messages sent within 14 days of onboarding
Note that for efficiency purposes, a single webhook could potentially describe thousands of messages, so we recommend that you capture its contents first, then process the contents asynchronously.
Phases and chunks
Webhooks are divided into three history phases, where day 0 indicates the time when the business was onboarded onto Cloud API:
- phase 0: day 0 through day 1
- phase 1: day 1 through day 90
- phase 2: day 90 through day 180
For each phase, chat history webhooks may be sent in separate chunks, depending on the total number of messages that comprise the thread.
- you can use the
chunk_orderparameter value to arrange these chunks in their sequential order, as they may not be delivered sequentially - you can use the
phaseparameter value to monitor phase progress. A value of2indicates that the current phase is complete. - you can use the
progressparameter value to monitor the overall progress. A value of100indicates that synchronization is complete.
If there is no chat history available for a given phase, no corresponding webhooks will be sent.
Payload contents
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | The business customer's WhatsApp Business Account ID. | 102290129340398 |
| business_phone String | The business customer's business phone number. | 15550783881 |
| phone_number_id String | The business customer's business phone number ID. | 106540352242922 |
| phase Integer | Indicates history phase. Values can be:0 — indicates messages are from day 0 (business onboarding time) through day 11 — indicates messages are from day 1 through day 902 — indicates messages are from day 90 through day 180 |
1 |
| chunk_order Integer | Indicates chunk number, which you can use to order sets of webhooks sequentially. | 1 |
| progress Integer | Indicates percentage total of synchronization progress.Minimum 0, maximum 100. |
55 |
| id String | WhatsApp message ID. | wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0N0FCNjMA |
| timestamp String | Unix timestamp indicating when the message was received by the recipient's device. | 1738796547 |
| type String | Message type. Note that this placeholder appears twice in the syntax above, as it serves as a placeholder for the type property's value and its matching property name. See the example payload below for a thread with various message types.If this value is set to media_placeholder, the message object describes a message that contained a media asset. In this case, the message contents will be omitted. Instead, a separate history webhook will follow, describing the content of the message and the media asset ID, but only if the message was sent within the last two weeks of your query. See the example payload below describing a media message's contents. |
text |
| content Object | An object describing the message's contents. This value will vary based on the message type, as well as the contents message.For example, if a business sends an image message without a caption, the object would not include the caption property.See Sending messages for examples of payloads for each message type. |
{"body":"Here's the info you requested! https://www.meta.com/quest/quest-3/"} |
| status String | Indicates the message's most recent delivery stats. Values can be:DELIVERED``ERROR``PENDING``PLAYED``READ``SENT |
READ |
webhook
{
"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"
}
}
smb_message_echoes
Describes a message sent by a business customer to a WhatsApp user with the WhatsApp Business app or supported companion device
Trigger events
- A business customer uses the WhatsApp Business app or supported companion device to message a WhatsApp user.
Payload contents
| Placeholder | Description | Example value |
|---|---|---|
| wabaId String | The business customer's WhatsApp Business Account ID. | 102290129340398 |
| business_phoneString | The business customer's business phone number. | 15550783881 |
| phone_number_id String | The business customer's business phone number ID. | 106540352242922 |
| id String | WhatsApp message ID. | wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0N0FCNjMA |
| timestamp String | Unix timestamp indicated when the webhook was triggered. | 1738796547 |
| type String | Message type. Note that this placeholder appears twice in the syntax above, as it serves as a placeholder for the type property's value and its matching property name. |
text |
{
"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"
}
}
delivered
{
"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": "1982889945839747"
}
read
{
"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"
}