LINE API

หมายเหตุ

ก่อนส่งข้อความ LINE โปรดตรวจสอบให้แน่ใจว่าแพลตฟอร์ม Line ได้รับการกำหนดค่าอย่างถูกต้อง เรียนรู้เพิ่มเติม

createLineMessage

ใช้สำหรับส่งข้อความ LINE ไปยังผู้ใช้

POST https://api.pushwoosh.com/json/1.3/createLineMessage

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

ข้อความ LINE แบบง่ายที่ประกอบด้วยข้อความธรรมดาเท่านั้น ไม่มีรูปภาพหรือปุ่ม เรียนรู้เพิ่มเติม

เคล็ดลับ: สำหรับการจัดรูปแบบขั้นสูงและสื่อสมบูรณ์ ให้ใช้เทมเพลตข้อความเช่น Flex, รูปภาพ, หรือ คารูเซล

เนื้อหาของคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API สำหรับการรับรองความถูกต้องของคำขอ
notifications	array of objects	ใช่	รายการของอ็อบเจกต์ข้อความ LINE ที่จะส่ง
content	string	ใช่	ข้อความของข้อความ LINE ที่จะส่ง จำกัดตัวอักษรสูงสุด: 5000 หมายเหตุ: หากมีทั้ง preset และ content รวมอยู่ด้วย ค่าจากคำขอจะแทนที่ preset
preset	string	ไม่	รหัสของ LINE preset ที่คุณสร้างใน Pushwoosh Control Panel หมายเหตุ: หากมีทั้ง preset และ content รวมอยู่ด้วย ค่าจากคำขอจะแทนที่ preset
send_date	string	ใช่	วันที่และเวลาที่จะส่งข้อความ ใช้รูปแบบ YYYY-MM-DD HH:mm หรือ now เพื่อส่งทันที
devices	array of strings	ใช่	รายการรหัสอุปกรณ์ (user IDs) ที่จะส่งข้อความ LINE ไปให้

{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

ส่งข้อความรูปภาพ

คุณสามารถส่ง ข้อความรูปภาพ ไปยังผู้ใช้ LINE โดยการระบุอ็อบเจกต์รูปภาพภายในฟิลด์เทมเพลตของคำขอของคุณ

ข้อความรูปภาพแต่ละข้อความต้องการ URL รูปภาพสองรายการ: หนึ่งสำหรับ รูปภาพขนาดเต็ม (image_url) และอีกหนึ่งสำหรับ ภาพตัวอย่าง (preview_image_url) เมื่อผู้ใช้แตะที่ภาพตัวอย่าง รูปภาพขนาดเต็มจะเปิดขึ้น ตรวจสอบให้แน่ใจว่า URL ทั้งสองใช้ HTTPS (TLS 1.2 หรือใหม่กว่า) และเชื่อมโยงไปยังไฟล์รูปภาพที่สามารถเข้าถึงได้แบบสาธารณะ

สำหรับรายละเอียด โปรดดูที่ส่วน ข้อความรูปภาพ ในเอกสารประกอบ LINE Messaging API

เนื้อหาของคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API ที่ใช้ในการรับรองความถูกต้องของคำขอ
notifications	array of objects	ใช่	รายการข้อความที่จะส่ง
content	string	ใช่	ใช้เป็นข้อความสำรองหรือข้อความตัวอย่างสำหรับข้อความ รหัสของ LINE preset ที่คุณสร้างใน Pushwoosh Control Panel หมายเหตุ: หากมีทั้ง preset และ template รวมอยู่ด้วย template จากคำขอจะถูกนำมาใช้ หากมีทั้ง preset และ content รวมอยู่ด้วย content จากคำขอจะแทนที่ preset
send_date	string	ใช่	วันที่และเวลาที่จะส่งข้อความ ใช้รูปแบบ YYYY-MM-DD HH:mm หรือ now เพื่อส่งทันที
devices	array of strings	ใช่	รายการรหัสอุปกรณ์ (user IDs) ที่จะส่งข้อความ LINE ไปให้
preset	string	ไม่	รหัสของ LINE preset ที่คุณสร้างใน Pushwoosh Control Panel หมายเหตุ: หากมีทั้งพารามิเตอร์ preset และ template รวมอยู่ในคำขอ ค่าจาก template จะแทนที่ค่าที่กำหนดไว้ใน preset หากมีทั้ง preset และ content รวมอยู่ในคำขอเดียวกัน content ที่ให้มาโดยตรงในคำขอจะแทนที่เนื้อหาจาก preset
template	object	ใช่	เทมเพลตเค้าโครงข้อความ รองรับประเภทข้อความหลายประเภท ดูรายละเอียดด้านล่าง

พารามิเตอร์เทมเพลต

ประเภท: image

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
image_url	string	ใช่	URL ของรูปภาพขนาดเต็ม (ต้องใช้ HTTPS) ความยาวสูงสุด: 2000 ตัวอักษร รูปแบบ: JPEG, PNG ขนาดสูงสุด: 10 MB
preview_image_url	string	ใช่	URL ของภาพตัวอย่างที่แสดงในแชท (ต้องใช้ HTTPS) ความยาวสูงสุด: 2000 ตัวอักษร รูปแบบ: JPEG, PNG ขนาดสูงสุด: 1 MB

ตัวอย่างคำขอ

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image": {
              "alt_text": "some text",
              "image_url": "https://images.com/1.jpg",
              "preview_image_url": "https://images.com/1.png"
            }
          }
        }
      }
    ]
  }
}

ส่งข้อความรูปภาพแบบคารูเซล

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

รูปแบบนี้เหมาะสำหรับการนำเสนอสินค้า โปรโมชั่น หรือการเลือกชมภาพในรูปแบบที่น่าสนใจ

สำหรับรายละเอียด โปรดอ้างอิงถึงส่วน เทมเพลตคารูเซลรูปภาพ ในเอกสารประกอบ LINE Messaging API

เนื้อหาของคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API ที่ใช้ในการรับรองความถูกต้องของคำขอ
notifications	array of objects	ใช่	รายการข้อความที่จะส่ง
content	string	ใช่	ใช้เป็นข้อความสำรองหรือข้อความตัวอย่างสำหรับข้อความ หมายเหตุ: หากตั้งค่าทั้ง content และ template จะใช้ template หากมีทั้ง preset และ content รวมอยู่ในคำขอเดียวกัน content ที่ให้มาโดยตรงในคำขอจะแทนที่เนื้อหาจาก preset
send_date	string	ใช่	วันที่และเวลาที่จะส่งข้อความ ใช้รูปแบบ YYYY-MM-DD HH:mm หรือ "now"
devices	array of strings	ใช่	รายการรหัสอุปกรณ์ (user IDs) ที่จะส่งข้อความ LINE ไปให้
preset	string	ไม่	รหัสของ LINE preset ที่คุณสร้างใน Pushwoosh Control Panel หมายเหตุ: หากมีทั้งพารามิเตอร์ preset และ template รวมอยู่ในคำขอ ค่าจาก template จะแทนที่ค่าที่กำหนดไว้ใน preset หากมีทั้ง preset และ content รวมอยู่ในคำขอเดียวกัน content ที่ให้มาโดยตรงในคำขอจะแทนที่เนื้อหาจาก preset
template	object	ใช่	เทมเพลตเค้าโครงข้อความ รองรับประเภทข้อความหลายประเภท ดูรายละเอียดด้านล่าง

พารามิเตอร์เทมเพลต

ประเภท: image_carousel

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
alt_text	string	ใช่	ข้อความสำรองที่แสดงในการแสดงตัวอย่างพุชและบนอุปกรณ์ที่ไม่รองรับ สูงสุด 400 ตัวอักษร
columns	array of objects	ใช่	อาร์เรย์ของคอลัมน์รูปภาพ (รองรับ 1–10 คอลัมน์) แต่ละคอลัมน์จะมีรูปภาพ
image_url	string	ใช่	URL ของรูปภาพที่แสดงในแต่ละคอลัมน์ของคารูเซล ซึ่งชี้ไปยังไฟล์ JPEG หรือ PNG ที่สามารถเข้าถึงได้แบบสาธารณะ ต้องใช้ HTTPS

ตัวอย่างคำขอ

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image_carousel": {
              "alt_text": "some text",
              "columns": [
                { "image_url": "https://images.com/1.jpg" },
                { "image_url": "https://images.com/2.jpg" },
                { "image_url": "https://images.com/3.jpg" }
              ]
            }
          }
        }
      }
    ]
  }
}

ส่งข้อความ Flex

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

ในการส่ง Flex Message ให้รวมอ็อบเจกต์ template ที่มี raw payload อยู่ในคำขอของคุณ เค้าโครงข้อความต้องเป็นไปตาม ข้อกำหนดของ LINE Flex Message

เคล็ดลับ: คุณสามารถออกแบบและดูตัวอย่าง Flex Messages ได้โดยใช้ LINE Flex Message Simulator

เนื้อหาของคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
application	string	ใช่	รหัสแอปพลิเคชัน Pushwoosh
auth	string	ใช่	โทเค็นการเข้าถึง API ที่ใช้ในการรับรองความถูกต้องของคำขอ
notifications	array of objects	ใช่	รายการข้อความที่จะส่ง
content	string	ใช่	ใช้เป็นข้อความสำรองหรือข้อความตัวอย่างสำหรับข้อความ หมายเหตุ: หากตั้งค่าทั้ง content และ template จะใช้เทมเพลต หากมีทั้ง preset และ content รวมอยู่ด้วย เนื้อหาจากคำขอจะแทนที่ preset
send_date	string	ใช่	เวลาที่จะส่งข้อความ ใช้รูปแบบ "now" หรือ YYYY-MM-DD HH:mm
devices	array of strings	ใช่	รายการของโทเค็นอุปกรณ์ LINE (user IDs) ที่จะรับข้อความ
preset	string	ไม่	รหัสของ LINE preset ที่คุณสร้างใน Pushwoosh Control Panel หมายเหตุ: หากมีทั้ง preset และ template รวมอยู่ด้วย เทมเพลตจะแทนที่ preset หากมีทั้ง preset และ content รวมอยู่ด้วย เนื้อหาจากคำขอจะแทนที่ preset
template	object	ใช่	เทมเพลตเค้าโครงข้อความ รองรับประเภทข้อความหลายประเภท ดูรายละเอียดด้านล่าง

พารามิเตอร์เทมเพลต

สำหรับ Flex Message ให้ใช้โครงสร้างแบบ raw
ประเภท: raw (Flex)

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
alt_text	string	ใช่	ข้อความสำรองที่แสดงในการแจ้งเตือน การแสดงตัวอย่างแชท และการอ้างอิง สูงสุด 400 ตัวอักษร
content	object	ใช่	เค้าโครงของ Flex Message ซึ่งมีโครงสร้างโดยใช้ bubble, box, text, และส่วนประกอบอื่นๆ ตามข้อกำหนด Flex ของ LINE

ตัวอย่างคำขอ

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
        "preset": "preset_code",
        "template": {
          "en": {
            "raw": {
              "alt_text": "My raw template",
              "content": {
                "type": "bubble",
                "body": {
                  "type": "box",
                  "layout": "vertical",
                  "contents": [
                    {
                      "type": "text",
                      "text": "RECEIPT",
                      "weight": "bold",
                      "color": "#1DB446",
                      "size": "sm"
                    }
                    // Additional components...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}