เอกสารนี้นี้ได้รับการอัพเดตแล้ว
คำแปลเป็น ภาษาไทย ยังไม่เสร็จสมบูรณ์
ภาษาอังกฤษที่อัพเดต: 31 ม.ค.

ข้อความ

ใช้ตำแหน่งข้อมูล /PHONE_NUMBER_ID/messages ในการส่งข้อความตัวอักษร, สื่อ, ผู้ติดต่อ, ตำแหน่ง และข้อความแบบอินเทอร์แอคทีฟ รวมถึงเทมเพลตข้อความให้กับลูกค้าของคุณ เรียนรู้เพิ่มเติมเกี่ยวกับข้อความที่คุณสามารถส่งได้

ตำแหน่งข้อมูลการยืนยันตัวตน

/PHONE_NUMBER_ID/messages

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 whatsapp_business_messaging permission.

ข้อความจะถูกระบุด้วย ID ที่ไม่ซ้ำกัน (WAMID) คุณสามารถติดตามสถานะข้อความได้ใน Webhooks โดยใช้ WAMID คุณยังสามารถทำเครื่องหมายข้อความขาเข้าว่า "อ่านแล้ว" ผ่านตำแหน่งข้อมูลข้อความได้อีกด้วย WAMID นี้มีความยาวได้สูงสุด 128 อักขระ

เมื่อใช้ API ระบบคลาวด์ คุณจะไม่มีวิธีที่ตรวจสอบได้อย่างชัดเจนอีกต่อไปว่าหมายเลขโทรศัพท์หนึ่งๆ มี WhatsApp ID หรือไม่ หากต้องการส่งข้อความถึงผู้ใช้ด้วย API ระบบคลาวด์ ให้ส่งข้อความไปยังหมายเลขโทรศัพท์ของลูกค้าโดยตรง หลังจากที่ลูกค้าได้แสดงความต้องการที่จะเลือกรับข้อความแล้ว โปรดดูตัวอย่างที่ข้อมูลอ้างอิง, ข้อความ

อ็อบเจ็กต์ข้อความ

หากต้องการส่งข้อความ คุณต้องรวมอ็อบเจ็กต์ข้อความที่มีเนื้อหาที่คุณต้องการส่งก่อน พารามิเตอร์เหล่านี้คือพารามิเตอร์ที่ใช้ในอ็อบเจ็กต์ message:

ชื่อคำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ)

audio

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=audio

อ็อบเจ็กต์ media ที่มีเสียง

biz_opaque_callback_data

สตริง

ระบุหรือไม่ก็ได้

สตริงแบบกำหนดเองซึ่งมีประโยชน์สำหรับการติดตาม


ตัวอย่างเช่น คุณสามารถส่ง ID เทมเพลตข้อความในช่องนี้เพื่อติดตามเส้นทางการคอนเวอร์ชั่นของลูกค้าโดยเริ่มจากข้อความแรกที่คุณส่ง จากนั้น คุณจะสามารถติดตาม ROI ของเทมเพลตข้อความประเภทต่างๆ เพื่อระบุประเภทที่มีประสิทธิภาพสูงสุด


แอพที่สมัครรับข้อมูลจากช่อง Webhook messages ในบัญชี WhatsApp Business สามารถรับสตริงนี้ได้ เนื่องจากรวมอยู่ในอ็อบเจ็กต์ statuses ภายในเพย์โหลดของ Webhook


API ระบบคลาวด์ไม่ได้ประมวลผลช่องนี้ เพียงแต่จะส่งคืนช่องโดยเป็นส่วนหนึ่งของ Webhooks ข้อความที่ส่ง/ได้รับ/อ่านแล้ว


สูงสุด 512 อักขระ


เฉพาะ API ระบบคลาวด์

contacts

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=contacts

อ็อบเจ็กต์ contacts

context

อ็อบเจ็กต์

จำเป็นต้องระบุหากตอบกลับข้อความในการสนทนา

อ็อบเจ็กต์ที่มี ID ของข้อความก่อนหน้าที่คุณกำลังตอบกลับ ตัวอย่างเช่น:


{"message_id":"MESSAGE_ID"}


เฉพาะ API ระบบคลาวด์

document

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=document

อ็อบเจ็กต์ media ที่มีเอกสาร

hsm

อ็อบเจ็กต์

ประกอบด้วยอ็อบเจ็กต์ hsm ตัวเลือกนี้ถูกเลิกใช้งานแล้วใน v2.39 ของ API ภายในองค์กร ให้ใช้อ็อบเจ็กต์ template แทน


เฉพาะ API ภายในองค์กร

image

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=image

อ็อบเจ็กต์ media ที่มีรูปภาพ

interactive

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=interactive

อ็อบเจ็กต์ interactive โดยทั่วไปแล้ว องค์ประกอบของอ็อบเจ็กต์ interactive แต่ละรายการจะมีรูปแบบที่สอดคล้องกัน ได้แก่ header, body, footer และ action

location

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=location

อ็อบเจ็กต์ location

messaging_product

สตริง

จำเป็นต้องระบุ

บริการส่งข้อความที่ใช้สำหรับคำขอ ให้ใช้ "whatsapp"


เฉพาะ API ระบบคลาวด์

preview_url

บูลีน

จำเป็นต้องระบุหาก type=text

อนุญาตให้แสดงตัวอย่าง URL ในข้อความตัวอักษร โปรดดูการส่ง URL ในข้อความตัวอักษร ช่องนี้เป็นช่องที่จะระบุหรือไม่ก็ได้ หากไม่มี URL ในข้อความของคุณ ค่า:false (ค่าเริ่มต้น), true


เฉพาะ API ภายในองค์กร ผู้ใช้ API ระบบคลาวด์สามารถใช้ฟังก์ชั่นเดียวกันนี้กับช่อง preview_url ภายในอ็อบเจ็กต์ข้อความได้

recipient_type

สตริง

ระบุหรือไม่ก็ได้

ขณะนี้คุณสามารถส่งข้อความถึงบุคคลได้เท่านั้น ตั้งค่าเป็น individual


ค่าเริ่มต้น: individual

status

สตริง

สถานะของข้อความ คุณสามารถใช้ช่องนี้เพื่อทำเครื่องหมายข้อความว่า read โปรดดูข้อมูลได้จากคู่มือต่อไปนี้


sticker

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=sticker

อ็อบเจ็กต์ media ที่มีสติกเกอร์


API ระบบคลาวด์: ระบบรองรับสติกเกอร์ขาออกของบุคคลที่สามแบบภาพนิ่งและแบบเคลื่อนไหว นอกเหนือจากสติกเกอร์ขาเข้าทุกประเภท สติกเกอร์แบบภาพนิ่งจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 100 KB สติกเกอร์แบบเคลื่อนไหวจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 500 KB


API ภายในองค์กร: ระบบรองรับเฉพาะสติกเกอร์ขาออกของบุคคลที่สามแบบภาพนิ่ง นอกเหนือจากสติกเกอร์ขาเข้าทุกประเภท สติกเกอร์แบบภาพนิ่งจะต้องมีความละเอียด 512x512 พิกเซล และต้องมีขนาดไม่เกิน 100 KB ระบบไม่รองรับสติกเกอร์แบบเคลื่อนไหว

template

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=template

อ็อบเจ็กต์ template

text

อ็อบเจ็กต์

จำเป็นต้องระบุสำหรับข้อความตัวอักษร

อ็อบเจ็กต์ text

to

สตริง

จำเป็นต้องระบุ

WhatsApp ID หรือหมายเลขโทรศัพท์ของลูกค้าที่คุณต้องการจะส่งข้อความไปหา โปรดดูรูปแบบหมายเลขโทรศัพท์


หากจำเป็น ผู้ใช้ API ภายในองค์กรสามารถรับหมายเลขนี้ได้โดยการเรียกใช้ตำแหน่งข้อมูล contacts

type

สตริง

ระบุหรือไม่ก็ได้

ประเภทของข้อความที่คุณต้องการส่ง หากละไว้ ค่าเริ่มต้นจะเป็น text

อ็อบเจ็กต์ต่อไปนี้จะซ้อนอยู่ภายในอ็อบเจ็กต์ข้อความ:

อ็อบเจ็กต์ผู้ติดต่อ

NameDescription

addresses

object

Optional.

Full contact address(es) formatted as an addresses object. The object can contain the following fields:

streetstringOptional. Street number and name.

citystringOptional. City name.

statestringOptional. State abbreviation.

zipstringOptional. ZIP code.

countrystringOptional. Full country name.

country_codestringOptional. Two-letter country abbreviation.

typestringOptional. Standard values are HOME and WORK.

birthday

Optional.

YYYY-MM-DD formatted string.

emails

object

Optional.

Contact email address(es) formatted as an emails object. The object can contain the following fields:

emailstringOptional. Email address.

typestringOptional. Standard values are HOME and WORK.

name

object

Required.

Full contact name formatted as a name object. The object can contain the following fields:

formatted_namestringRequired. Full name, as it normally appears.

first_namestringOptional*. First name.

last_namestringOptional*. Last name.

middle_namestringOptional*. Middle name.

suffixstringOptional*. Name suffix.

prefixstringOptional*. Name prefix.


*At least one of the optional parameters needs to be included along with the formatted_name parameter.

org

object

Optional.

Contact organization information formatted as an org object. The object can contain the following fields:

companystringOptional. Name of the contact's company.

departmentstringOptional. Name of the contact's department.

titlestringOptional. Contact's business title.

phones

object

Optional.

Contact phone number(s) formatted as a phone object. The object can contain the following fields:

phonestringOptional. Automatically populated with the `wa_id` value as a formatted phone number.

typestringOptional. Standard Values are CELL, MAIN, IPHONE, HOME, and WORK.

wa_idstringOptional. WhatsApp ID.

urls

object

Optional.

Contact URL(s) formatted as a urls object. The object can contain the following fields:

urlstringOptional. URL.

typestringOptional. Standard values are HOME and WORK.

อ็อบเจ็กต์แบบอินเทอร์แอคทีฟ

ชื่อคำอธิบาย

action

อ็อบเจ็กต์

จำเป็นต้องระบุ

การดำเนินการที่คุณต้องการให้ผู้ใช้กระทำหลังจากที่อ่านข้อความ

body

อ็อบเจ็กต์

ระบุหรือไม่ก็ได้สำหรับประเภท product แต่จำเป็นต้องระบุสำหรับข้อความประเภทอื่นๆ

อ็อบเจ็กต์ที่มีเนื้อหาของข้อความ


อ็อบเจ็กต์ body ประกอบด้วยช่องต่อไปนี้

textสตริงจำเป็นต้องระบุหากมีเนื้อหาปรากฏอยู่ เนื้อหาของข้อความ ระบบรองรับอีโมจิและมาร์กดาวน์ ความยาวสูงสุด: 1,024 อักขระ

footer

อ็อบเจ็กต์

ระบุหรือไม่ก็ได้ อ็อบเจ็กต์ที่มีส่วนท้ายของข้อความ


อ็อบเจ็กต์ footer ประกอบด้วยช่องต่อไปนี้

textสตริงจำเป็นต้องระบุหากมีส่วนท้ายปรากฏอยู่ เนื้อหาส่วนท้าย ระบบรองรับอีโมจิ มาร์กดาวน์ และลิงก์ ความยาวสูงสุด: 60 อักขระ

header

อ็อบเจ็กต์

จำเป็นต้องระบุสำหรับประเภท product_list แต่จะระบุหรือไม่ก็ได้สำหรับประเภทอื่นๆ

เนื้อหาส่วนหัวที่แสดงอยู่ด้านบนข้อความ ทั้งนี้ คุณจะไม่สามารถตั้งค่าส่วนหัวได้หากอ็อบเจ็กต์แบบอินเทอร์แอคทีฟของคุณเป็นประเภท product โปรดดูข้อมูลเพิ่มเติมที่อ็อบเจ็กต์ header

type

อ็อบเจ็กต์

จำเป็นต้องระบุ

ประเภทของข้อความแบบอินเทอร์แอคทีฟที่คุณต้องการส่ง ค่าที่รองรับ ได้แก่


  • button: ใช้สำหรับปุ่มตอบกลับ
  • catalog_message: ใช้สำหรับข้อความแบบแค็ตตาล็อก
  • list: ใช้สำหรับข้อความแบบรายการ
  • product: ใช้สำหรับข้อความที่มีผลิตภัณฑ์รายการเดียว
  • product_list: ใช้สำหรับข้อความที่มีผลิตภัณฑ์หลายรายการ
  • flow: ใช้สำหรับข้อความแบบขั้นตอน

อ็อบเจ็กต์ต่อไปนี้จะซ้อนอยู่ภายในอ็อบเจ็กต์ interactive:

อ็อบเจ็กต์การดำเนินการ

ชื่อคำอธิบาย

button

สตริง

จำเป็นต้องระบุสำหรับข้อความแบบรายการ

เนื้อหาในปุ่ม สตริงนี้จะเว้นว่างไม่ได้และต้องไม่ซ้ำกันภายในข้อความ ระบบรองรับอีโมจิ แต่ไม่รองรับมาร์กดาวน์


ความยาวสูงสุด: 20 อักขระ

buttons

อาร์เรย์ของอ็อบเจ็กต์

จำเป็นต้องระบุสำหรับปุ่มตอบกลับ

อ็อบเจ็กต์ปุ่มสามารถมีพารามิเตอร์ต่อไปนี้ได้


  • type: ประเภทเดียวที่รองรับคือ reply (สำหรับปุ่มตอบกลับ)
  • title: ชื่อปุ่ม สตริงนี้จะเว้นว่างไม่ได้และต้องไม่ซ้ำกันภายในข้อความ ระบบรองรับอีโมจิ แต่ไม่รองรับมาร์กดาวน์ ความยาวสูงสุด: 20 อักขระ
  • id: ตัวระบุที่ไม่ซ้ำกันสำหรับปุ่มของคุณ ระบบจะส่งคืน ID นี้ใน Webhook เมื่อผู้ใช้คลิกปุ่ม ความยาวสูงสุด: 256 อักขระ

คุณสามารถมีปุ่มได้สูงสุด 3 ปุ่ม คุณจะตั้งค่า ID โดยขึ้นต้นหรือลงท้ายด้วยการเว้นวรรคไม่ได้

catalog_id

สตริง

จำเป็นต้องระบุสำหรับข้อความที่มีผลิตภัณฑ์รายการเดียวและข้อความที่มีผลิตภัณฑ์หลายรายการ

ตัวระบุที่ไม่ซ้ำกันของแค็ตตาล็อกบน Facebook ที่เชื่อมโยงไปยังบัญชี WhatsApp Business ของคุณ คุณสามารถดึง ID นี้ได้ผ่านทางตัวจัดการการค้าของ Meta

product_retailer_id

สตริง

จำเป็นต้องระบุสำหรับข้อความที่มีผลิตภัณฑ์รายการเดียวและข้อความที่มีผลิตภัณฑ์หลายรายการ

ตัวระบุที่ไม่ซ้ำกันของผลิตภัณฑ์ในแค็ตตาล็อก


หากต้องการรับ ID นี้ ให้ไปที่ตัวจัดการการค้าของ Meta และเลือกบัญชีธุรกิจ Meta ของคุณ คุณจะเห็นรายชื่อร้านค้าที่เชื่อมต่อกับบัญชีของคุณ คลิกที่ร้านค้าที่คุณต้องการใช้ ในแผงด้านซ้าย ให้คลิกที่แค็ตตาล็อก > รายการ และค้นหารายการที่คุณต้องการกล่าวถึง ID สำหรับรายการดังกล่าวจะแสดงใต้ชื่อของรายการนั้น

sections

อาร์เรย์ของอ็อบเจ็กต์

จำเป็นต้องระบุสำหรับข้อความแบบรายการและข้อความที่มีผลิตภัณฑ์หลายรายการ

อาร์เรย์ของอ็อบเจ็กต์ section ขั้นต่ำ 1 รายการ, สูงสุด 10 รายการ โปรดดูที่อ็อบเจ็กต์ section

mode

สตริง

ระบุหรือไม่ก็ได้สำหรับข้อความแบบขั้นตอน

โหมดปัจจุบันของขั้นตอน โดยอาจเป็น draft หรือ published


ค่าเริ่มต้น: published

flow_message_version

สตริง

จำเป็นต้องระบุสำหรับข้อความแบบขั้นตอน

ต้องเป็น 3

flow_token

สตริง

จำเป็นต้องระบุสำหรับข้อความแบบขั้นตอน

โทเค็นที่ธุรกิจสร้างขึ้นเพื่อใช้เป็นตัวระบุ

flow_id

สตริง

จำเป็นต้องระบุสำหรับข้อความแบบขั้นตอน

ตัวระบุที่ไม่ซ้ำกันของขั้นตอนที่ได้มาจาก WhatsApp

flow_cta

สตริง

จำเป็นต้องระบุสำหรับข้อความแบบขั้นตอน

ข้อความบนปุ่ม CTA เช่น "สมัคร"


ความยาวสูงสุด: 20 อักขระ (ไม่มีอีโมจิ)

flow_action

สตริง

ระบุหรือไม่ก็ได้สำหรับข้อความแบบขั้นตอน

navigate หรือ data_exchange ใช้ navigate เพื่อกำหนดหน้าจอแรกที่จะใช้เป็นส่วนหนึ่งของข้อความไว้ล่วงหน้า ใช้ data_exchange สำหรับกรณีการใช้งานขั้นสูง ซึ่งหน้าจอแรกจะได้มาจากตำแหน่งข้อมูลของคุณ


ค่าเริ่มต้น: navigate

flow_action_payload

อ็อบเจ็กต์

ระบุหรือไม่ก็ได้สำหรับข้อความแบบขั้นตอน

ต้องระบุก็ต่อเมื่อ flow_action คือ navigate อ็อบเจ็กต์สามารถมีพารามิเตอร์ต่อไปนี้ได้

screenสตริงจำเป็นต้องระบุid ของหน้าจอแรกของขั้นตอน

dataอ็อบเจ็กต์ระบุหรือไม่ก็ได้ ข้อมูลอินพุตสำหรับหน้าจอแรกของขั้นตอน ต้องเป็นอ็อบเจ็กต์ที่ไม่ว่างเปล่า

อ็อบเจ็กต์ส่วนหัว

ชื่อคำอธิบาย

document

อ็อบเจ็กต์

จำเป็นต้องระบุ หากตั้งค่า type เป็น document

ประกอบด้วยอ็อบเจ็กต์สื่อสำหรับเอกสารนี้

image

อ็อบเจ็กต์

จำเป็นต้องระบุ หากตั้งค่า type เป็น image

ประกอบด้วยอ็อบเจ็กต์สื่อสำหรับรูปภาพนี้

text

สตริง

จำเป็นต้องระบุ หากตั้งค่า type เป็น text

ข้อความสำหรับส่วนหัว การจัดรูปแบบอนุญาตให้ใช้อีโมจิได้ แต่ใช้มาร์กดาวน์ไม่ได้


ความยาวสูงสุด: 60 อักขระ

type

สตริง

จำเป็นต้องระบุ

ประเภทส่วนหัวที่คุณต้องการใช้ ค่าที่รองรับ ได้แก่


  • text: ใช้สำหรับข้อความแบบรายการ ปุ่มตอบกลับ และข้อความที่มีผลิตภัณฑ์หลายรายการ
  • video: ใช้สำหรับปุ่มตอบกลับ
  • image: ใช้สำหรับปุ่มตอบกลับ
  • document: ใช้สำหรับปุ่มตอบกลับ

video

อ็อบเจ็กต์

จำเป็นต้องระบุ หากตั้งค่า type เป็น video

ประกอบด้วยอ็อบเจ็กต์สื่อสำหรับวิดีโอนี้

อ็อบเจ็กต์ส่วน

ชื่อคำอธิบาย

product_items

อาร์เรย์ของอ็อบเจ็กต์

จำเป็นต้องระบุสำหรับข้อความที่มีผลิตภัณฑ์หลายรายการ

อาร์เรย์ของอ็อบเจ็กต์ product หนึ่งส่วนจะมีผลิตภัณฑ์อย่างน้อย 1 รายการ และสูงสุด 30 รายการในทุกส่วนรวมกัน


อ็อบเจ็กต์ product แต่ละรายการจะประกอบด้วยช่องต่อไปนี้


  • product_retailer_idสตริงจำเป็นต้องระบุสำหรับข้อความที่มีผลิตภัณฑ์หลายรายการ ตัวระบุที่ไม่ซ้ำกันของผลิตภัณฑ์ในแค็ตตาล็อก หากต้องการรับ ID นี้ ให้ไปที่ตัวจัดการการค้าของ Meta แล้วเลือกบัญชีของคุณและร้านค้าที่คุณต้องการใช้ จากนั้นให้คลิกที่ "แค็ตตาล็อก" > "รายการ" และค้นหารายการที่คุณต้องการกล่าวถึง ID สำหรับรายการดังกล่าวจะแสดงใต้ชื่อของรายการนั้น

rows

อาร์เรย์ของอ็อบเจ็กต์

จำเป็นต้องระบุสำหรับข้อความแบบรายการ

ประกอบด้วยรายชื่อแถว คุณสามารถมีแถวในส่วนต่างๆ ได้ทั้งหมด 10 แถว


แต่ละแถวต้องมีชื่อ (ความยาวสูงสุด: 24 อักขระ) และ ID (ความยาวสูงสุด: 200 อักขระ) คุณสามารถเพิ่มคำอธิบายได้ (ความยาวสูงสุด: 72 อักขระ) แต่จะใส่หรือไม่ก็ได้


ตัวอย่าง:

"rows": [
  {
   "id":"unique-row-identifier-here",
   "title": "row-title-content-here",
   "description": "row-description-content-here",           
   }
]

title

สตริง

จำเป็นต้องระบุ หากข้อความมีมากกว่า 1 ส่วน

ชื่อของส่วน


ความยาวสูงสุด: 24 อักขระ

อ็อบเจ็กต์ตำแหน่ง

NameDescription

latitude

Required.

Location latitude in decimal degrees.

longitude

Required.

Location longitude in decimal degrees.

name

Required.

Name of the location.

address

Required.

Address of the location.

อ็อบเจ็กต์สื่อ

โปรดดูข้อมูลเกี่ยวกับวิธีการรับ ID ของออบเจ็กต์สื่อของคุณได้ที่ "รับ ID สื่อ" โปรดดูข้อมูลเกี่ยวกับประเภทสื่อที่รองรับสำหรับ API ระบบคลาวด์ได้ที่ "ประเภทสื่อที่รองรับ"

NameDescription

id

string

Required when type is audio, document, image, sticker, or video and you are not using a link.


The media object ID. Do not use this field when message type is set to text.

link

string

Required when type is audio, document, image, sticker, or video and you are not using an uploaded media ID (i.e. you are hosting the media asset on your public server).

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.


Do not use this field when message type is set to text.


Cloud API users only:


  • See Media HTTP Caching if you would like us to cache the media asset for future messages.
  • When we request the media asset from your server you must indicate the media's MIME type by including the Content-Type HTTP header. For example: Content-Type: video/mp4. See Supported Media Types for a list of supported media and their MIME types.

caption

string

Optional.


Media asset caption. Do not use with audio or sticker media.


On-Premises API users:

  • For v2.41.2 or newer, this field is is limited to 1024 characters.
  • Captions are currently not supported for document media.

filename

string

Optional.


Describes the filename for the specific document. Use only with document media.


The extension of the filename will specify what format the document is displayed as in WhatsApp.

provider

string

Optional. On-Premises API only.

This path is optionally used with a link when the HTTP/HTTPS link is not directly accessible and requires additional configurations like a bearer token. For information on configuring providers, see the Media Providers documentation.

อ็อบเจ็กต์เทมเพลต

มีการเปลี่ยนแปลงการกำหนดราคาตามการสนทนา เรียนรู้วิธีการทำงานของรูปแบบการกำหนดราคาตามการสนทนารูปแบบใหม่ของเราได้ที่หัวข้อ "การกำหนดราคา"

นอกจากนี้ยังมีการเปลี่ยนแปลงการแสดงผลของ metric_types โดยเริ่มมีผลตั้งแต่วันที่ 1 กรกฎาคม 2023 โปรดดูรายละเอียดเพิ่มเติมได้ที่ "ตารางการวิเคราะห์การสนทนา"

NameDescription

name

Required.

Name of the template.

language

object

Required.

Contains a language object. Specifies the language the template may be rendered in.


The language object can contain the following fields:

policystringRequired. The language policy the message should follow. The only supported option is deterministic. See Language Policy Options.

codestringRequired. The code of the language or locale to use. Accepts both language and language_locale formats (e.g., en and en_US). For all codes, see Supported Languages.

components

array of objects

Optional.

Array of components objects containing the parameters of the message.

namespace

Optional. Only used for On-Premises API.

Namespace of the template.

อ็อบเจ็กต์ต่อไปนี้จะซ้อนอยู่ภายในอ็อบเจ็กต์ template:

อ็อบเจ็กต์พารามิเตอร์ของปุ่ม

ชื่อคำอธิบาย (คลิกที่ลูกศรในคอลัมน์ด้านซ้ายเพื่อดูตัวเลือกที่รองรับ)

type

สตริง

จำเป็นต้องระบุ

ระบุประเภทพารามิเตอร์ของปุ่ม

ตัวเลือกที่รองรับ

  • "payload"
  • "text"

payload

จำเป็นต้องระบุสำหรับปุ่ม quick_reply

ระบบจะส่งคืนเพย์โหลดที่ผู้พัฒนากำหนดเมื่อมีการคลิกปุ่ม นอกเหนือจากข้อความที่แสดงบนปุ่ม


โปรดดูตัวอย่างได้ที่ "การเรียกกลับจากการคลิกปุ่มตอบกลับด่วน"

text

จำเป็นต้องระบุสำหรับปุ่ม URL

คำต่อท้ายที่ได้จากผู้พัฒนาซึ่งจะต่อท้าย URL พรีฟิกซ์ที่กำหนดไว้ล่วงหน้าในเทมเพลต

อ็อบเจ็กต์องค์ประกอบ

NameDescription (Click the arrow in the left column for supported options.)

type

string

Required.

Describes the component type.


Example of a components object with an array of parameters object nested inside:

 "components": [{
   "type": "body",
   "parameters": [{
                "type": "text",
                "text": "name"
            },
            {
            "type": "text",
            "text": "Hi there"
            }]
      }] 

Supported Options

  • header
  • body
  • button

For text-based templates, we only support the type=body.

sub_type

string

Required when type=button. Not used for the other types.

Type of button to create.

Supported Options

  • quick_reply: Refers to a previously created quick reply button that allows for the customer to return a predefined message.
  • url: Refers to a previously created button that allows the customer to visit the URL generated by appending the text parameter to the predefined prefix URL in the template.
  • catalog: Refers to a previously created catalog button that allows for the customer to return a full product catalog.

parameters

array of objects

Required when type=button.

Array of parameter objects with the content of the message.

For components of type=button, see the button parameter object.

index

Required when type=button. Not used for the other types.

Position index of the button. You can have up to 10 buttons using index values of 0 to 9.

อ็อบเจ็กต์สกุลเงิน

ชื่อคำอธิบาย

fallback_value

จำเป็นต้องระบุ

ข้อความเริ่มต้น หากไม่สามารถแปลภาษาได้

code

จำเป็นต้องระบุ

รหัสสกุลเงินตามที่กำหนดไว้ใน ISO 4217

amount_1000

จำเป็นต้องระบุ

จำนวนคูณด้วย 1000

อ็อบเจ็กต์ Date_Time

ชื่อคำอธิบาย

fallback_value

จำเป็นต้องระบุ

ข้อความเริ่มต้น สำหรับ API ระบบคลาวด์ เราจะใช้ค่าสำรองเสมอ และเราจะไม่พยายามแปลภาษาโดยใช้ช่องอื่นๆ ที่จะระบุหรือไม่ก็ได้

อ็อบเจ็กต์พารามิเตอร์

ชื่อคำอธิบาย

type

สตริง

จำเป็นต้องระบุ

อธิบายประเภทพารามิเตอร์ ค่าที่รองรับ ได้แก่


  • currency
  • date_time
  • document
  • image
  • text
  • video

ประเภทพารามิเตอร์ที่รองรับสำหรับเทมเพลตแบบข้อความมีเพียง currency, date_time และ text เท่านั้น

text

สตริง

จำเป็นต้องระบุเมื่อ type=text

ตัวอักษรของข้อความ จำนวนอักขระสูงสุดจะแตกต่างกันไปตามประเภทองค์ประกอบที่รวมอยู่ต่อไปนี้


สำหรับองค์ประกอบประเภท header

  • 60 อักขระ

สำหรับองค์ประกอบประเภท body

  • 1,024 อักขระ หากมีองค์ประกอบประเภทอื่นรวมอยู่ด้วย
  • 32,768 อักขระ หากมีเพียงองค์ประกอบประเภท body

currency

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=currency

อ็อบเจ็กต์ currency

date_time

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=date_time

อ็อบเจ็กต์ date_time

image

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=image

อ็อบเจ็กต์ media ของประเภท image ระบบไม่รองรับคำบรรยายเมื่อใช้ในเทมเพลตสื่อ

document

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=document

อ็อบเจ็กต์ media ของประเภท document เทมเพลตข้อความแบบสื่อรองรับเฉพาะเอกสาร PDF เท่านั้น ระบบไม่รองรับคำบรรยายเมื่อใช้ในเทมเพลตสื่อ

video

อ็อบเจ็กต์

จำเป็นต้องระบุเมื่อ type=video

อ็อบเจ็กต์ media ของประเภท video ระบบไม่รองรับคำบรรยายเมื่อใช้ในเทมเพลตสื่อ

อ็อบเจ็กต์ข้อความ

ชื่อคำอธิบาย

body

สตริง

จำเป็นต้องระบุสำหรับข้อความตัวอักษร

ข้อความของข้อความตัวอักษรที่สามารถมี URL ที่ขึ้นต้นด้วย http:// หรือ https:// และมีการจัดรูปแบบ โปรดดูตัวเลือกการจัดรูปแบบที่ใช้ได้ที่นี่


หากคุณใส่ URL ไว้ในข้อความและต้องการให้มีกล่องแสดงตัวอย่างในข้อความแบบตัวอักษร (preview_url: true) URL จะต้องขึ้นต้นด้วย http:// หรือ https:// (ขอแนะนำให้ใช้ URL https://) คุณต้องระบุชื่อโฮสต์ เนื่องจากระบบจะถือว่าที่อยู่ IP ไม่ตรงกัน


ความยาวสูงสุด: 4,096 อักขระ

preview_url

บูลีน

ระบุหรือไม่ก็ได้ เฉพาะ API ระบบคลาวด์

ตั้งค่าเป็น true เพื่อให้แอพ WhatsApp Messenger และ WhatsApp Business พยายามแสดงตัวอย่างลิงก์ของ URL ในสตริงข้อความ body URI จะต้องขึ้นต้นด้วย http:// หรือ https:// หากมีหลาย URL ในสตริงข้อความ body ระบบจะแสดงเฉพาะ URL แรกเท่านั้น


หากระบบละเว้น preview_url หรือหากไม่สามารถเรียกดูตัวอย่างได้ ระบบจะแสดงลิงก์ที่คลิกได้แทน


สำหรับผู้ใช้ API ภายในองค์กร ให้ใช้ preview_url ในเพย์โหลดข้อความระดับสูงสุดแทน โปรดดูพารามิเตอร์

อ็อบเจ็กต์การแสดงความรู้สึก

ชื่อคำอธิบาย

message_id

สตริง

จำเป็นต้องระบุ

ID ข้อความ WhatsApp (wamid) ของข้อความที่ควรปรากฏการแสดงความรู้สึก ระบบจะไม่ส่งการแสดงความรู้สึกในกรณีดังต่อไปนี้


  • ข้อความเก่ากว่า 30 วัน
  • ข้อความนั้นเป็นข้อความแสดงความรู้สึก
  • ข้อความถูกลบแล้ว

หาก ID เป็นของข้อความที่ถูกลบ ข้อความดังกล่าวจะไม่ถูกส่ง

emoji

สตริง

จำเป็นต้องระบุ

อีโมจิที่จะปรากฏในข้อความ


  • ระบบรองรับอีโมจิทั้งหมดที่อุปกรณ์ Android และ iOS รองรับ
  • ระบบรองรับอีโมจิที่แสดงผล
  • หากใช้ค่ายูนิโค้ดอีโมจิ ค่าจะต้องเข้ารหัสด้วย Java หรือ JavaScript-escape
  • สามารถส่งอีโมจิได้เพียงตัวเดียวในข้อความแสดงความรู้สึก
  • ใช้สตริงว่างเพื่อลบอีโมจิที่ส่งไปก่อนหน้านี้

ภาพรวม

คู่มือ

โปรดดูคู่มือต่อไปนี้เพื่อเรียนรู้ข้อมูลทั้งหมดเกี่ยวกับวิธีใช้ตำแหน่งข้อมูล /messages เพื่อส่งข้อความ

ตัวอย่าง

ข้อความตัวอักษร

curl -X  POST \
'https://graph.facebook.com/v19.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"
        }
    }'

ข้อความแสดงความรู้สึก

curl -X  POST \
 'https://graph.facebook.com/v19.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"
  }
}'

ข้อความสื่อ

curl -X  POST \
 'https://graph.facebook.com/v19.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"
  }
}'

ข้อความแสดงตำแหน่ง

curl -X  POST \
 'https://graph.facebook.com/v19.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
  }
}'

ข้อความผู้ติดต่อ

curl -X  POST \
 'https://graph.facebook.com/v19.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"
        }]
    }]
}'

ข้อความแบบอินเทอร์แอคทีฟ

ข้อความที่มีผลิตภัณฑ์รายการเดียว

curl -X  POST \
 'https://graph.facebook.com/v19.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"
     }
   }
 }'

ข้อความที่มีผลิตภัณฑ์หลายรายการ

curl -X  POST \
 'https://graph.facebook.com/v19.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" },
             ...
           ]
         }
       ]
     }
   }
 }

ข้อความแบบแค็ตตาล็อก

curl -X  POST \
 'https://graph.facebook.com/v19.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>"
      }
    }
  }
}'

ข้อความแบบขั้นตอน

curl -X  POST \
 'https://graph.facebook.com/v19.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
          }
        }
      }
    }
  }
}'
  

ข้อความแบบรายการ

curl -X  POST \
 'https://graph.facebook.com/v19.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"
            }
          ]
        }
      ]
    }
  }
}'

ปุ่มตอบกลับ

curl -X  POST \
 'https://graph.facebook.com/v19.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"
          }
        }
      ]
    }
  }
}'

ข้อความเทมเพลต

มีการเปลี่ยนแปลงการกำหนดราคาตามการสนทนา เรียนรู้วิธีการทำงานของรูปแบบการกำหนดราคาตามการสนทนารูปแบบใหม่ของเราได้ที่หัวข้อ "การกำหนดราคา"

นอกจากนี้ยังมีการเปลี่ยนแปลงการแสดงผลของ metric_types โดยเริ่มมีผลตั้งแต่วันที่ 1 กรกฎาคม 2023 โปรดดูรายละเอียดเพิ่มเติมได้ที่ "ตารางการวิเคราะห์การสนทนา"

curl -X  POST \
 'https://graph.facebook.com/v19.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"
          }
        ]
      }
    ]
  }
}'

ตอบกลับข้อความ

curl -X POST \
 'https://graph.facebook.com/v19.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"
  }
}’

การตอบกลับที่สำเร็จ

    {
      "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",
        }
      ]
    }