คำแปลเป็น ภาษาไทย ยังไม่เสร็จสมบูรณ์
ภาษาไทย ที่อัพเดต:
We are making changes to the WhatsApp Business Platform pricing model. See Pricing Updates on the WhatsApp Business Platform.
Messages
Use the /PHONE_NUMBER_ID/messages endpoint to send text, media, contacts, location, and interactive messages, as well as message templates to your customers. Learn more about the messages you can send.
| Endpoint | Authentication |
|---|---|
(โปรดดูที่ เรียกดู ID หมายเลขโทรศัพท์) | Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup.
Solution Partners must authenticate themselves with an access token with the |
Messages are identified by a unique ID (WAMID). You can track message status in the Webhooks through its WAMID. You could also mark an incoming message as read through messages endpoint. This WAMID can have a maximum length of up to 128 characters.
เมื่อใช้ API ระบบคลาวด์ คุณจะไม่มีวิธีที่ตรวจสอบได้อย่างชัดเจนอีกต่อไปว่าหมายเลขโทรศัพท์หนึ่งๆ มี WhatsApp ID หรือไม่ หากต้องการส่งข้อความถึงผู้ใช้ด้วย API ระบบคลาวด์ ให้ส่งข้อความไปยังหมายเลขโทรศัพท์ของลูกค้าโดยตรง หลังจากที่ลูกค้าได้แสดงความต้องการที่จะเลือกรับข้อความแล้ว โปรดดูตัวอย่างที่ข้อมูลอ้างอิง, ข้อความ
Message Object
To send a message, you must first assemble a message object with the content you want to send. These are the parameters used in a message object:
| ชื่อ | คำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ) |
|---|---|
| จำเป็นต้องระบุเมื่อ อ็อบเจ็กต์ |
| ระบุหรือไม่ก็ได้ สตริงแบบกำหนดเองซึ่งมีประโยชน์สำหรับการติดตาม ตัวอย่างเช่น คุณสามารถส่ง ID เทมเพลตข้อความในช่องนี้เพื่อติดตามเส้นทางการคอนเวอร์ชั่นของลูกค้าโดยเริ่มจากข้อความแรกที่คุณส่ง จากนั้น คุณจะสามารถติดตาม ROI ของเทมเพลตข้อความประเภทต่างๆ เพื่อระบุประเภทที่มีประสิทธิภาพสูงสุด แอพที่สมัครรับข้อมูลจากช่อง Webhook API ระบบคลาวด์ไม่ได้ประมวลผลช่องนี้ เพียงแต่จะส่งคืนช่องโดยเป็นส่วนหนึ่งของ Webhooks ข้อความที่ส่ง/ได้รับ/อ่านแล้ว สูงสุด 512 อักขระ เฉพาะ API ระบบคลาวด์ |
| จำเป็นต้องระบุเมื่อ |
| จำเป็นต้องระบุหากตอบกลับข้อความในการสนทนา อ็อบเจ็กต์ที่มี ID ของข้อความก่อนหน้าที่คุณกำลังตอบกลับ ตัวอย่างเช่น:
เฉพาะ API ระบบคลาวด์ |
| จำเป็นต้องระบุเมื่อ อ็อบเจ็กต์ |
| ประกอบด้วยอ็อบเจ็กต์ เฉพาะ API ภายในองค์กร |
| จำเป็นต้องระบุเมื่อ อ็อบเจ็กต์ |
| จำเป็นต้องระบุเมื่อ อ็อบเจ็กต์ |
| จำเป็นต้องระบุเมื่อ |
| จำเป็นต้องระบุ บริการส่งข้อความที่ใช้สำหรับคำขอ ให้ใช้ เฉพาะ API ระบบคลาวด์ |
| จำเป็นต้องระบุหาก อนุญาตให้แสดงตัวอย่าง URL ในข้อความตัวอักษร โปรดดูการส่ง URL ในข้อความตัวอักษร ช่องนี้เป็นช่องที่จะระบุหรือไม่ก็ได้ หากไม่มี URL ในข้อความของคุณ ค่า: เฉพาะ API ภายในองค์กร ผู้ใช้ API ระบบคลาวด์สามารถใช้ฟังก์ชั่นเดียวกันนี้กับช่อง |
| ระบุหรือไม่ก็ได้ ขณะนี้คุณสามารถส่งข้อความถึงบุคคลได้เท่านั้น ตั้งค่าเป็น ค่าเริ่มต้น: |
| สถานะของข้อความ คุณสามารถใช้ช่องนี้เพื่อทำเครื่องหมายข้อความว่า
|
| จำเป็นต้องระบุเมื่อ อ็อบเจ็กต์ API ระบบคลาวด์: ระบบรองรับสติกเกอร์ขาออกของบุคคลที่สามแบบภาพนิ่งและแบบเคลื่อนไหว นอกเหนือจากสติกเกอร์ขาเข้าทุกประเภท สติกเกอร์แบบภาพนิ่งจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 100 KB สติกเกอร์แบบเคลื่อนไหวจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 500 KB API ภายในองค์กร: ระบบรองรับเฉพาะสติกเกอร์ขาออกของบุคคลที่สามแบบภาพนิ่ง นอกเหนือจากสติกเกอร์ขาเข้าทุกประเภท สติกเกอร์แบบภาพนิ่งจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 100 KB ระบบไม่รองรับสติกเกอร์แบบเคลื่อนไหว |
| จำเป็นต้องระบุเมื่อ |
| จำเป็นต้องระบุสำหรับข้อความตัวอักษร |
| จำเป็นต้องระบุ WhatsApp ID หรือหมายเลขโทรศัพท์ของลูกค้าที่คุณต้องการจะส่งข้อความไปหา โปรดดูรูปแบบหมายเลขโทรศัพท์ หากจำเป็น ผู้ใช้ API ภายในองค์กรสามารถรับหมายเลขนี้ได้โดยการเรียกใช้ตำแหน่งข้อมูล |
| ระบุหรือไม่ก็ได้ ประเภทของข้อความที่คุณต้องการส่ง หากละไว้ ค่าเริ่มต้นจะเป็น |
The following objects are nested inside the message object:
- Text object
- Media object
- Reaction object
- Template object
- Location object
- Contacts object
- Interactive object
Contacts Object
| Name | Description |
|---|---|
| Optional. Full contact address(es) formatted as an
|
| Optional.
|
| Optional. Contact email address(es) formatted as an
|
| Required. Full contact name formatted as a
*At least one of the optional parameters needs to be included along with the |
| Optional. Contact organization information formatted as an
|
| Optional. Contact phone number(s) formatted as a
|
| Optional. Contact URL(s) formatted as a
|
Interactive Object
| Name | Description |
|---|---|
| Required. Action you want the user to perform after reading the message. |
| Optional for type An object with the body of the message. The
|
| Optional. An object with the footer of the message. The
|
| Required for type Header content displayed on top of a message. You cannot set a header if your interactive object is of |
| Required. The type of interactive message you want to send. Supported values:
|
The following objects are nested inside the interactive object:
Action Object
| Name | Description |
|---|---|
| Required for List Messages. Button content. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 characters. |
| Required for Reply Buttons. A button object can contain the following parameters:
You can have up to 3 buttons. You cannot have leading or trailing spaces when setting the ID. |
| Required for Single Product Messages and Multi-Product Messages. Unique identifier of the Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via the Meta Commerce Manager. |
| Required for Single Product Messages and Multi-Product Messages. Unique identifier of the product in a catalog. To get this ID go to Meta Commerce Manager and select your Meta Business account. You will see a list of shops connected to your account. Click the shop you want to use. On the left-side panel, click Catalog > Items, and find the item you want to mention. The ID for that item is displayed under the item's name. |
| Required for List Messages and Multi-Product Messages. Array of |
| Optional for Flows Messages. The current mode of the Flow, either Default: |
| Required for Flows Messages. Must be |
| Required for Flows Messages. A token that is generated by the business to serve as an identifier. |
| Required for Flows Messages. Unique identifier of the Flow provided by WhatsApp. |
| Required for Flows Messages. Text on the CTA button, eg. "Signup". Maximum length: 20 characters (no emoji). |
| Optional for Flows Messages.
Default: |
| Optional for Flows Messages. Required only if
|
Header Object
| Name | Description |
|---|---|
| Required if Contains the media object for this document. |
| Required if Contains the media object for this image. |
| Required if Text for the header. Formatting allows emojis, but not markdown. Maximum length: 60 characters. |
| Optional. Text for the header. Formatting allows emojis, but not markdown. Maximum length: 60 characters. |
| Required. The header type you would like to use. Supported values:
|
| Required if Contains the media object for this video. |
Section Object
| Name | Description |
|---|---|
| Required for Multi-Product Messages. Array of Each
|
| Required for List Messages. Contains a list of rows. You can have a total of 10 rows across your sections. Each row must have a title (Maximum length: 24 characters) and an ID (Maximum length: 200 characters). You can add a description (Maximum length: 72 characters), but it is optional. Example: "rows": [
{
"id":"unique-row-identifier-here",
"title": "row-title-content-here",
"description": "row-description-content-here",
}
] |
| Required if the message has more than one section. Title of the section. Maximum length: 24 characters. |
Location Object
| Name | Description |
|---|---|
| Required. Location latitude in decimal degrees. |
| Required. Location longitude in decimal degrees. |
| Required. Name of the location. |
| Required. Address of the location. |
Media Object
See Get Media ID for information on how to get the ID of your media object. For information about supported media types for Cloud API, see Supported Media Types.
| Name | Description |
|---|---|
| Required when The media object ID. Do not use this field when message |
| Required when The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Do not use this field when message Cloud API users only:
|
| Optional. Media asset caption. Do not use with On-Premises API users:
|
| Optional. Describes the filename for the specific document. Use only with The extension of the filename will specify what format the document is displayed as in WhatsApp. |
| Optional. On-Premises API only. This path is optionally used with a |
Template Object
| Name | Description |
|---|---|
| Required. Name of the template. |
| Required. Contains a The
|
| Optional. Array of |
| Optional. Only used for On-Premises API. Namespace of the template. |
The following objects are nested inside the template object:
Button Parameter Object
| Name | Description (Click the arrow in the left column for supported options.) |
|---|---|
| Required. Indicates the type of parameter for the button. |
| Required for Developer-defined payload that is returned when the button is clicked in addition to the display text on the button. See Callback from a Quick Reply Button Click for an example. |
| Required for URL buttons. Developer-provided suffix that is appended to the predefined prefix URL in the template. |
Components Object
| Name | Description (Click the arrow in the left column for supported options.) |
|---|---|
| Required. Describes the Example of a
"components": [{
"type": "body",
"parameters": [{
"type": "text",
"text": "name"
},
{
"type": "text",
"text": "Hi there"
}]
}] |
| Required when Type of button to create. |
| Required when Array of For components of type=button, see the |
| Required when Position index of the button. You can have up to 10 buttons using index values of 0 to 9. |
Currency Object
| Name | Description |
|---|---|
| Required. Default text if localization fails. |
| Required. Currency code as defined in |
| Required. Amount multiplied by 1000. |
Date_Time Object
| Name | Description |
|---|---|
| Required. Default text. For Cloud API, we always use the fallback value, and we do not attempt to localize using other optional fields. |
Parameter Object
| Name | Description |
|---|---|
| Required. Describes the parameter type. Supported values:
For text-based templates, the only supported parameter types are |
| Required when The message’s text. Character limit varies based on the following included component type. For the
For the
|
| Required when |
| Required when |
| Required when A |
| Required when A |
| Required when A |
Text Object
| Name | Description |
|---|---|
| Required for text messages. The text of the text message which can contain URLs which begin with http:// or https:// and formatting. See available formatting options here. If you include URLs in your text and want to include a preview box in text messages ( Maximum length: 4096 characters |
| Optional. Cloud API only. Set to If On-Premises API users, use |
Reaction Object
| Name | Description |
|---|---|
| Required. The WhatsApp Message ID (wamid) of the message on which the reaction should appear. The reaction will not be sent if:
If the ID is of a message that has been deleted, the message will not be delivered. |
| Required. Emoji to appear on the message.
|
Overview
Guides
See the following guides for full information on how to use the /messages endpoint to send messages:
Examples
Text Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "text",
"text": { // the text object
"preview_url": false,
"body": "MESSAGE_CONTENT"
}
}'
Reaction Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "reaction",
"reaction": {
"message_id": "wamid.HBgLM...",
"emoji": "\uD83D\uDE00"
}
}'
Media Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM-PHONE-NUMBER-ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE-NUMBER",
"type": "image",
"image": {
"id" : "MEDIA-OBJECT-ID"
}
}'
Location Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"to": "PHONE_NUMBER",
"type": "location",
"location": {
"longitude": LONG_NUMBER,
"latitude": LAT_NUMBER,
"name": LOCATION_NAME,
"address": LOCATION_ADDRESS
}
}'
Contact Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"to": "PHONE_NUMBER",
"type": "contacts",
"contacts": [{
"addresses": [{
"street": "STREET",
"city": "CITY",
"state": "STATE",
"zip": "ZIP",
"country": "COUNTRY",
"country_code": "COUNTRY_CODE",
"type": "HOME"
},
{
"street": "STREET",
"city": "CITY",
"state": "STATE",
"zip": "ZIP",
"country": "COUNTRY",
"country_code": "COUNTRY_CODE",
"type": "WORK"
}],
"birthday": "YEAR_MONTH_DAY",
"emails": [{
"email": "EMAIL",
"type": "WORK"
},
{
"email": "EMAIL",
"type": "HOME"
}],
"name": {
"formatted_name": "NAME",
"first_name": "FIRST_NAME",
"last_name": "LAST_NAME",
"middle_name": "MIDDLE_NAME",
"suffix": "SUFFIX",
"prefix": "PREFIX"
},
"org": {
"company": "COMPANY",
"department": "DEPARTMENT",
"title": "TITLE"
},
"phones": [{
"phone": "PHONE_NUMBER",
"type": "HOME"
},
{
"phone": "PHONE_NUMBER",
"type": "WORK",
"wa_id": "PHONE_OR_WA_ID"
}],
"urls": [{
"url": "URL",
"type": "WORK"
},
{
"url": "URL",
"type": "HOME"
}]
}]
}'
Interactive Messages
Single-Product Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive": {
"type": "product",
"body": {
"text": "optional body text"
},
"footer": {
"text": "optional footer text"
},
"action": {
"catalog_id": "CATALOG_ID",
"product_retailer_id": "ID_TEST_ITEM_1"
}
}
}'
Multi-Product Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive": {
"type": "product_list",
"header":{
"type": "text",
"text": "header-content"
},
"body": {
"text": "body-content"
},
"footer": {
"text": "footer-content"
},
"action": {
"catalog_id": "CATALOG_ID",
"sections": [
{
"title": "section-title",
"product_items": [
{ "product_retailer_id": "product-SKU-in-catalog" },
{ "product_retailer_id": "product-SKU-in-catalog" },
...
]
},
{
"title": "section-title",
"product_items": [
{ "product_retailer_id": "product-SKU-in-catalog" },
{ "product_retailer_id": "product-SKU-in-catalog" },
...
]
}
]
}
}
}
Catalog Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive" : {
"type" : "catalog_message",
"body" : {
"text": "Thanks for your order! Tell us what address you’d like this order delivered to."
},
"action": {
"name": "catalog_message",
"parameters": {
"thumbnail_product_retailer_id": "<Product-retailer-id>"
}
}
}
}'
Flows Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive" : {
"type": "flow",
"header": {
"type": "text",
"text": "Flow message header"
},
"body": {
"text": "Flow message body"
},
"footer": {
"text": "Flow message footer"
},
"action": {
"name": "flow",
"parameters": {
"flow_message_version": "3",
"flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
"flow_id": "<FLOW_ID>",
"flow_cta": "Book!",
"flow_action": "navigate",
"flow_action_payload": {
"screen": "<SCREEN_ID>",
"data": {
"user_name": "name",
"user_age": 25
}
}
}
}
}
}'
List Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive": {
"type": "list",
"header": {
"type": "text",
"text": "HEADER_TEXT"
},
"body": {
"text": "BODY_TEXT"
},
"footer": {
"text": "FOOTER_TEXT"
},
"action": {
"button": "BUTTON_TEXT",
"sections": [
{
"title": "SECTION_1_TITLE",
"rows": [
{
"id": "SECTION_1_ROW_1_ID",
"title": "SECTION_1_ROW_1_TITLE",
"description": "SECTION_1_ROW_1_DESCRIPTION"
},
{
"id": "SECTION_1_ROW_2_ID",
"title": "SECTION_1_ROW_2_TITLE",
"description": "SECTION_1_ROW_2_DESCRIPTION"
}
]
},
{
"title": "SECTION_2_TITLE",
"rows": [
{
"id": "SECTION_2_ROW_1_ID",
"title": "SECTION_2_ROW_1_TITLE",
"description": "SECTION_2_ROW_1_DESCRIPTION"
},
{
"id": "SECTION_2_ROW_2_ID",
"title": "SECTION_2_ROW_2_TITLE",
"description": "SECTION_2_ROW_2_DESCRIPTION"
}
]
}
]
}
}
}'
Reply Button
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "interactive",
"interactive": {
"type": "button",
"body": {
"text": "BUTTON_TEXT"
},
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"id": "UNIQUE_BUTTON_ID_1",
"title": "BUTTON_TITLE_1"
}
},
{
"type": "reply",
"reply": {
"id": "UNIQUE_BUTTON_ID_2",
"title": "BUTTON_TITLE_2"
}
}
]
}
}
}'
Template Messages
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"type": "template",
"template": {
"name": "TEMPLATE_NAME",
"language": {
"code": "LANGUAGE_AND_LOCALE_CODE"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"link": "http(s)://URL"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "TEXT_STRING"
},
{
"type": "currency",
"currency": {
"fallback_value": "VALUE",
"code": "USD",
"amount_1000": NUMBER
}
},
{
"type": "date_time",
"date_time": {
"fallback_value": "MONTH DAY, YEAR"
}
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": "0",
"parameters": [
{
"type": "payload",
"payload": "PAYLOAD"
}
]
},
{
"type": "button",
"sub_type": "quick_reply",
"index": "1",
"parameters": [
{
"type": "payload",
"payload": "PAYLOAD"
}
]
}
]
}
}'
Reply To Message
curl -X POST \
'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"context": {
"message_id": "MESSAGE_ID"
},
"to": "PHONE_NUMBER",
"type": "text",
"text": {
"preview_url": false,
"body": "your-text-message-content"
}
}’
Successful Response
{
"messaging_product": "whatsapp",
"contacts": [
{
"input": "16505555555",
"wa_id": "16505555555"
}
],
"messages": [
{
"id": "wamid.HBgLMTY1MDUwNzY1MjAVAgARGBI5QTNDQTVCM0Q0Q0Q2RTY3RTcA"
}
]
}
Applies to businesses in Brazil, Colombia, and Singapore, starting September 12, 2023. Applies to all businesses starting October 12, 2023.
Messages will have one of the following statuses which will be returned in each of the messages objects
"message_status":"accepted": means the message was sent to the intended recipient"message_status":"held_for_quality_assessment": means the message send was delayed until quality can be validated and it will either be sent or dropped at this point
{
"messaging_product": "whatsapp",
"contacts": [
{
"input": "16505555555",
"wa_id": "16505555555"
}
],
"messages": [
{
"id": "wamid.HBgLMTY1MDUwNzY1MjAVAgARGBI5QTNDQTVCM0Q0Q0Q2RTY3RTcA",
"message_status": "accepted",
}
]
}