ข้อความ

/v1/messages

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

โปรดดูข้อมูลเกี่ยวกับประเภทข้อความที่เฉพาะเจาะจงซึ่งคุณสามารถส่งได้ในคำแนะนำต่างๆ ได้แก่ ข้อความ SMS, ข้อความสื่อ, ข้อความแสดงผู้ติดต่อและตำแหน่ง, ข้อความอินเทอร์แอคทีฟ, เทมเพลตข้อความ, เทมเพลตข้อความสื่อ และเทมเพลตข้อความอินเทอร์แอคทีฟ

ก่อนเริ่มต้น

คุณจำเป็นต้องดำเนินการดังต่อไปนี้

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

ข้อจำกัด

• ระบบรองรับประเภทข้อความต่างๆ ได้แก่ ข้อความ SMS, เทมเพลตข้อความ, รูปภาพ, เอกสาร และเสียง
• ข้อความ SMS มีจำนวนอักขระได้สูงสุด 4,096 ตัว

การสร้าง

คุณส่งข้อความได้โดยเรียก POST ไปยังโหนด /messages ไม่ว่าจะเป็นข้อความประเภทใดก็ตาม เนื้อหาของข้อความ JSON จะแตกต่างกันไปตามข้อความแต่ละประเภท (ข้อความ รูปภาพ ฯลฯ)

พารามิเตอร์

พารามิเตอร์ต่อไปนี้เป็นพารามิเตอร์หลักที่ใช้ในการส่งคำขอ POST /messages

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

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

สำหรับ API ภายในองค์กร ระบบจะส่งคืน ID อ็อบเจ็กต์สื่อเมื่ออัพโหลดสื่อไปยังไคลเอ็นต์ภายในองค์กร/อ้างอิงของ WhatsApp Business ผ่านตำแหน่งข้อมูล media สำเร็จแล้ว

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

คุณสามารถวางอ็อบเจ็กต์ต่างๆ ได้แก่ addresses, emails, name, org, phone และ urls ซ้อนกันไว้ภายใน contacts ได้ ระบบจะรวมอ็อบเจ็กต์แบบ Pluralized ไว้ในอาร์เรย์ดังที่แสดงในตัวอย่างด้านล่าง

ตัวอย่างอ็อบเจ็กต์ contacts ซึ่งมีอ็อบเจ็กต์แบบ Pluralized วางซ้อนกันอยู่ภายใน

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

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

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

คุณสามารถวางอ็อบเจ็กต์ components และ language ซ้อนกันไว้ภายใน template ได้

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

คุณสามารถวางซ้อนอ็อบเจ็กต์ parameters ภายใน components ได้ และสามารถตั้งค่า type เป็น button ได้ด้วย

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

ประเภทปุ่ม

คุณสามารถตั้งค่า type เป็น button ภายในอ็อบเจ็กต์ components ได้ พารามิเตอร์ปุ่มมีดังต่อไปนี้

ตัวอย่างการกำหนด type เป็น button โดยมี sub_type เป็น quick_reply

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

ตัวอย่างการกำหนด type เป็น button โดยมี sub_type เป็น copy_code

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

อ็อบเจ็กต์ Hsm

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

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

ตัวอย่าง

ข้อความเสียง:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

ข้อความที่เป็นเอกสาร โดยใช้ filename:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

ข้อความที่เป็นเอกสาร โดยใช้ link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

ข้อความที่เป็นวิดีโอ โดยใช้ link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

ข้อความ SMS:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "text",
  "text": {
      "body": "your-message-content"
  }
}

ข้อความแบบอินเทอร์แอคทีฟ (รายการ):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

ข้อความแบบอินเทอร์แอคทีฟ (ปุ่มตอบกลับ):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

ข้อความแบบอินเทอร์แอคทีฟ (ข้อความที่มีผลิตภัณฑ์รายการเดียวและหลายรายการ):

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

ข้อความแบบอินเทอร์แอคทีฟ (ข้อความที่มีผลิตภัณฑ์หลายรายการ):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"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": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

ข้อความแบบอินเทอร์แอคทีฟ (ข้อความที่มีแค็ตตาล็อก):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

ข้อความแบบอินเทอร์แอคทีฟ (ขั้นตอน):

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "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": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

โค้ดต่อไปนี้แสดงตัวอย่างของ payload ในการตอบกลับ โดยจะละอ็อบเจ็กต์ meta และ error ไว้เพื่อความกระชับ

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

หากคำขอสำเร็จ คุณจะได้รับการตอบกลับพร้อม ID ข้อความ หากคำขอส่งคืนส่วนของ errors โปรดตรวจสอบข้อความตั้งต้น และแก้ไขข้อผิดพลาดก่อนที่จะส่งคำขออีกครั้ง โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดในรหัสข้อผิดพลาดของไคลเอ็นต์ภายในองค์กร/อ้างอิงของ WhatsApp Business และรหัสสถานะ HTTP

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

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

การจัดรูปแบบในข้อความ SMS

WhatsApp อนุญาตการจัดรูปแบบบางรูปแบบในข้อความ หากต้องการจัดรูปแบบข้อความบางส่วนหรือทั้งหมด ให้ใช้สัญลักษณ์การจัดรูปแบบเหล่านี้:

ประสิทธิภาพ

ในบริบทนี้ ประสิทธิภาพหมายถึงจำนวนข้อความที่สามารถส่งได้ภายในระยะเวลาวินาทีที่กำหนดโดยใช้ไคลเอ็นต์ภายในองค์กร/อ้างอิงของ WhatsApp Business ประสิทธิภาพสูงสุดที่ทำได้จะขึ้นอยู่กับหลากหลายปัจจัย โดยปัจจัยที่สำคัญที่สุดก็คือการเลือกตั้งค่าไคลเอ็นต์ของคุณและการกำหนดว่าจะส่งข้อความไปยังผู้ใช้ใหม่หรือผู้ใช้เดิม ทั้งนี้ หากส่งข้อความไปยังผู้ใช้ใหม่ เซสชั่นการเข้ารหัสจะใช้เวลานานขึ้นเล็กน้อย

คำถามที่พบบ่อย

เรียนรู้เพิ่มเติม

• เอกสารประกอบเกี่ยวกับการเข้าสู่ระบบและการยืนยันตัวตน
• เอกสารประกอบเกี่ยวกับผู้ติดต่อ
• รหัสข้อผิดพลาดของไคลเอ็นต์ภายในองค์กร/อ้างอิงของ WhatsApp Business
• รหัสสถานะ HTTP