收到的訊息範例
文字訊息
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages":[{
"from": "16315551234",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"timestamp": "1518694235",
"text": {
"body": "Hello this is an answer"
},
"type": "text"
}]
}
靜態位置訊息
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages":[{
"from":"16315551234",
"id":"ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"location":{
"address":"Main Street Beach, Santa Cruz, CA",
"latitude":38.9806263495,
"longitude":-131.9428612257,
"name":"Main Street Beach",
"url":"https://foursquare.com/v/4d7031d35b5df7744"},
"timestamp":"1521497875",
"type":"location"
}]
}
聯絡人訊息
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages": [{
"contacts": [{
"addresses": [{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "WORK",
"zip": "94025"
}],
"birthday": "2012-08-18",
"emails": [{
"email": "kfish@fb.com",
"type": "WORK"
}],
"ims": [{
"service": "AIM",
"user_id": "kfish"
}],
"name": {
"first_name": "Kerry",
"formatted_name": "Kerry Fisher",
"last_name": "Fisher"
},
"org": {
"company": "Meta",
"department": "WhatsApp"
},
"phones": [{
"phone": "+1 (940) 555-1234",
"type": "CELL"
},
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234"
}],
"urls": [{
"url": "https://www.facebook.com",
"type": "WORK"
}]
}],
"from": "16505551234",
"id": "ABGGFlA4dSRvAgo6C4Z53hMh1ugR",
"timestamp": "1537248012",
"type": "contacts"
}]
}
若消費顧客使用的是 iPhone，contact_image 設定為空白。
媒體訊息
含圖像的訊息：
{
"messages": [{
"from": "16315551234",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"image": {
"file": "/usr/local/wamedia/shared/b1cf38-8734-4ad3-b4a1-ef0c10d0d683",
"id": "b1c68f38-8734-4ad3-b4a1-ef0c10d683",
"mime_type": "image/jpeg",
"sha256": "29ed500fa64eb55fc19dc4124acb300e5dcc54a0f822a301ae99944db",
"caption": "Check out my new phone!",
"status": "downloaded"
},
"timestamp": "1521497954",
"type": "image"
}]
}
從2.49.1 版開始，媒體訊息 Webhooks 包含收到的媒體的狀態和編號。
下載狀態
| 狀態 | 說明 |
|---|---|
| 已成功下載媒體 |
| 未下載媒體，但可以使用重試端點重試下載 |
| 可能未下載媒體 |
caption 欄位在媒體訊息中為選填。用戶若有設定原文字幕，才會包含這個欄位。
含文件的訊息：
{
"messages": [{
"from": "16315551234",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"timestamp": "1522189546",
"type": "document",
"document": {
"caption": "80skaraokesonglistartist",
"file": "/usr/local/wamedia/shared/fc233119-733f-49c-bcbd-b2f68f798e33",
"id": "fc233119-733f-49c-bcbd-b2f68f798e33",
"mime_type": "application/pdf",
"sha256": "3b11fa6ef2bde1dd14726e09d3edaf782120919d06f6484f32d5d5caa4b8e",
"status": "downloaded"
}
}]
}
語音訊息：
{
"messages":[{
"from": "16315551234",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"timestamp": "1521827831",
"type": "voice",
"voice": {
"file": "/usr/local/wamedia/shared/463e/b7ec/ff4e4d9bb1101879cbd411b2",
"id": "463eb7ec-ff4e-4d9b-b110-1879cbd411b2",
"mime_type": "audio/ogg; codecs=opus",
"sha256": "fa9e1807d936b7cebe63654ea3a7912b1fa9479220258d823590521ef53b0710",
"status": "downloaded"
}
}]
}
含貼圖的訊息：
{
"messages":[{
"from": "16315551234",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"timestamp": "1521827831",
"type": "sticker",
"sticker": {
"id": "b1c68f38-8734-4ad3-b4a1-ef0c10d683",
"metadata": {
"sticker-pack-id": "463eb7ec-ff4e-4d9b-b110-1879cbd411b2",
"sticker-pack-name" : "Happy New Year",
"sticker-pack-publisher" : "Kerry Fisher",
"emojis": ["🐥", "😃"],
"ios-app-store-link" : "https://apps.apple.com/app/id3133333",
"android-app-store-link" : "https://play.google.com/store/apps/details?id=com.example",
"is-first-party-sticker" : 0 | 1 # integer
},
"mime_type": "image/webp",
"sha256": "fa9e1807d936b7cebe63654ea3a7912b1fa9479220258d823590521ef53b0710"
}
}]
}
WhatsApp 發訊廣告產生的訊息
{
"messages":[{
"from":"12345678",
"id":"ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"image":{
"id":"b1c68f38-8734-4ad3-b4a1-ef0c10d683",
"mime_type":"image/jpeg",
"sha256":"29ed500fa64eb55fc19dc4124acb300e5dcca0f822a301ae99944db"
"caption": "Check out my product!",
},
"timestamp":"1521497954",
"type":"image",
"referral" : {
"headline": "Our new product",
"body" : "This is a great product",
"source_type": "<SOURCE_TYPE>",
"source_id": "<SOURCE_ID>",
"source_url": "<SOURCE_URL>", //for the moment, this will always be a Facebook owned domain
"video": {
"id": "e144be57-12b1-4035-a520-703fcc87ef45",
"ctwa_clid": "<CTWA_CLID>",
}
}
}]
}範例：不支援的訊息
接收 unknown 回呼通知是可行的。以下舉例說明從顧客收到的不支援訊息類型。
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages": [{
"errors": [{
"code": 501,
"details": "Message type is not currently supported",
"title": "Unknown message type"
}],
"from": "16315551234",
"id": "ABGGFRBzFymPAgo6N9KKs7HsN6eB",
"timestamp": "1531933468",
"type": "unknown"
}]
}
轉寄的訊息
您可以看見收到的訊息是否為轉寄訊息，或者該則訊息的轉寄頻率是否非常高。轉寄的訊息通知如下：
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages": [{
"context": {
"forwarded": true
},
"from": "16315558011",
"id": "ABGGFmkiWVVPAgo-sOGh7pv13wVJ",
"text": {
"body": "Party at Dotty's tonight!"
},
"timestamp": "1593068329",
"type": "text"
}]
}
頻繁轉寄的訊息通知如下：
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages": [{
"context": {
"frequently_forwarded": true
},
"from": "16315558011",
"id": "ABGGFmkiWVVPAgo-sBTHfS3swNIl",
"timestamp": "1593068225",
"type": "video",
"video": {
"id": "e144be57-12b1-4035-a520-703fcc87ef45",
"mime_type": "video/mp4",
"sha256": "02c4e68a4f0d6af5ec6ef02120e20d15f520a4dd473b535abec1aab175c4e8b9"
}
}]
}
已啟用帳號安全通知
若在應用程式設定中將 show_security_notifications 參數設為 true，所有入站訊息通知都會包含與 identity 物件所含用戶身分相關的下列資訊：
{
"contacts": [{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
}],
"messages": [{
"from": "16315553601",
"id": "ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
"identity": {
"acknowledged": true,
"created_timestamp": 1602532300000,
"hash": "Sjvjlx8G6Z0="
},
"text": {
"body": "Hi from new number 3601"
},
"timestamp": "1602532300",
"type": "text"
}]
}快速回覆按鈕點擊次數產生的訊息
當您的顧客點擊快速回覆按鈕時，系統將傳送回應。以下是回呼格式的範例。注意：顧客可能不會點擊按鈕，而是回覆互動式訊息或只是向您傳送訊息。請確認您也能夠支援此類狀況。如需詳細資訊，請參閱 Webhooks 文件。
{
"contacts": [
{
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16505551234"
}
],
"messages": [
{
"button": {
"payload": "No-Button-Payload",
"text": "No"
},
"context": {
"from": "16315558007",
"id": "gBGGFmkiWVVPAgkgQkwi7IORac0"
},
"from": "16505551234",
"id": "ABGGFmkiWVVPAgo-sKD87hgxPHdF",
"timestamp": "1591210827",
"type": "button"
}
]
# If there are any errors, an errors field (array) will be present
"errors": [ { ... } ]
}
傳送訊息後傳入的回覆
用戶可以在 WhatsApp 中回覆特定訊息。為了讓商家理解訊息回覆的內容，我們會包含 context 物件。這個 context 物件會提供顧客所回覆訊息的 id、原始訊息發送者的 WhatsApp 編號，以及該顧客可能提及的任何產品編號。
回覆訊息提供更多資訊。
範例：顧客回覆了您的訊息
以下舉例說明一則回覆您所發送之訊息的入站訊息。詳情請參閱下方的context 物件一節。
{
"contacts": [ {
"profile": {
"name": "Kerry Fisher"
},
"wa_id": "16315551234"
} ],
"messages":[{
"context":{
"from":"16315558011",
"id":"ABGGFlA5FpafAgo6tHcNmNjXmuSf"
},
"from":"16315551234",
"id":"gBGGFlA5FpafAgkOuJbRq54qwbM",
"text":{"body":"Yes, count me in!"},
"timestamp":"1521499915",
"type":"text"
}]
}
text 欄位在媒體訊息中為選填。若有這個欄位，text 值就是所傳媒體的原文字幕，若回應是文字訊息，則是回應的內文。
範例：客戶回覆了一則清單訊息
{
"messages": [ {
"context": {
"from": "sender_wa_id_of_context_message",
"group_id": "group_id_of_context_message",
"id": "message_id_of_context_message",
"mentions": [ "wa_id1", "wa_id2" ]
},
"from": "sender_wa_id",
"group_id": "group_id",
"id": "message_id",
"timestamp": "message_timestamp",
"type": "interactive",
"interactive": {
"type": "list_reply",
"list_reply": {
"title": "row-title-content-here",
"id": "unique-row-identifier-here",
"description": "row-description-content-here"
}
}
}
範例：顧客回覆了一則回覆按鈕訊息
{
"messages": [
{
"context": {
"from": "sender_wa_id_of_context_message",
"group_id": "group_id_of_context_message",
"id": "message_id_of_context_message",
"mentions": [ "wa_id1", "wa_id2" ]
},
"from": "sender_wa_id",
"group_id": "group_id",
"id": "message_id",
"timestamp": "message_timestamp",
"type": "interactive",
"interactive": {
"type": "button_reply",
"button_reply": {
"id": "unique-button-identifier",
"title": "button-text"
}
} # end interactive node
} # end message item
] # end messages array
}範例：顧客洽詢與某項特定產品相關的資訊
{
"contacts": [
{
"profile": {
"name": "customer-name"
},
"wa_id": "customer-whatsapp-ID"
}
],
"messages": [
{
"from": "customer-whatsapp-ID",
"id": "message-ID",
"text": {
"body": "Can I get this in another color?"
},
"context": {
"referred_product": {
"catalog_id": "catalog-ID",
"product_retailer_id": "product-ID"
}
},
"timestamp": "message-received-timestamp",
"type": "text"
}
]
}
範例：客戶收到多項或單項產品訊息後下單
{
"messages": [ {
"from": "customer-whatsapp-id",
"group_id": "group-id",
"id": "message-ID",
"timestamp": "message-timestamp",
"type": "order"
"order": {
"catalog_id": "catalog_id",
"product_items": [
{
"product_retailer_id":"product-ID",
"quantity":"number-of-items",
"item_price":"unitary-price-of-item",
"currency":"price-currency"
},
...
],
"text":"text-message-sent-along-with-the-order"
}
}
}
入站系統訊息
系統訊息是系統在發生事件時產生的訊息。
範例：用戶變更號碼
若在應用程式設定中將 notify_user_change_number 參數設為 true，當用戶變更電話號碼時，您會收到入站系統訊息。
{
"messages": [
{
"from": "16315558889",
"id": "ABGGFjFVWIifAzNzeXMtMTYzMTU1NTg4ODlAcy53aGF0c2FwcC5uZXQtMTU3NDA4MDEwMjIxMy1jaGFuZ2U",
"system": {
"body": "User A changed from +1 (631) 555-8889 to +1 (631) 555-8890",
"new_wa_id": "16315558890",
"type": "user_changed_number"
},
"timestamp": "1574080102",
"type": "system"
}
]
}
範例：用戶可能有變
若在應用程式設定中將 show_security_notifications 參數設為 true，當（正在與您對話的）WhatsApp 用戶可能有變時，您會收到入站系統訊息。
使用 identity 端點確認這則通知之前，會封鎖發給該用戶的所有出站訊息。您仍然會正常收到傳入的訊息。
{
"messages": [
{
"from": "16315553601",
"id": "ABGGFjFVU2AfAzVzeXMtMTYzMTU1NTM2MDFAcy53aGF0c2FwcC5uZXQtMTYwMjUzNTM1NjMzMi1pZGVudGl0eQ",
"system": {
"body": "Test security code change",
"identity": "Rc/eg9Rl0JA=",
"type": "user_identity_changed",
"user": "16315553601"
},
"timestamp": "1602535356",
"type": "system"
}
]
}
系統訊息類型
| 系統訊息類型 | 說明 |
|---|---|
| 用戶已變更電話號碼 |
| 使用 WhatsApp 的用戶可能有變 |
在訊息中提及用戶
當您直接發送一則提及某個特定 WhatsApp 編號的訊息，且有用戶回覆該則訊息時，您會在 context 物件和 mentions 陣列中看見提及的編號。由於可以提及一個以上的電話號碼，mentions 欄位會是電話號碼陣列，即便只提及一個電話號碼也一樣。
範例：用戶回覆訊息
以下舉例說明顧客回覆一則包含提及內容的訊息。context 物件包含原始訊息中提及的號碼。text 物件中的回覆再次提及同一個號碼。
{
"messages": [{
"context": {
"from": "16315555544",
"id": "gBGGFlA5FpafAgkOuJbRq54qwbM",
"mentions": [
"16315551000",
"16315551099"
]
},
"from": "16315551234 ",
"id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf",
"timestamp": "1504902988",
"text": {
"body": "@16315551000 and @16315551099 are mentioned"
},
"type": "text"
}]
}