Send Message

ใช้สำหรับส่ง SMS ในรูปแบบที่หลากหลาย และมีความยืนหยุ่นในการใช้งาน functions ต่าง ๆ เช่น ส่งเลขหมายปลายทางได้หลายเบอร์ ตั้งเวลาการส่งล่วงหน้าได้ การกำหนดระยะเวลาที่จะให้พยายามส่งข้อความ การกำหนด custom bulkId และ messageID เป็นต้น

Sequence Diagram

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL):	https://api-service.ants.co.th/sms/send
HTTP Headers	Content-Type: application/json Authorization: (Basic Auth) Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP Methods	POST

ผู้ใช้งานสามารถระบุ Request body ด้วย Parameter ดังนี้

Parameter	ประเภท	รายละเอียด
bulkId (optional)	String (50)	รหัสของแต่ละ Request ที่ไม่ซ้ำกัน
messages	Array	ชุดข้อมูลที่ต้องการส่งข้อความ
from	String (11)	เป็นการกำหนดค่าชื่อผู้ส่ง (Sender Name) สามารถระบุเป็นตัวหนังสือ ตัวเลข หรือตัวเลข ปนตัวหนังสือได้ สูงสุดไม่เกิน 11 ตัวอักษร และไม่สามารถเว้นวรรคได้ เช่น ANTS เป็นต้น
destinations	Array (500)	ชุดข้อมูลหมายเลขที่ต้องการส่งข้อความ *แนะนำ สูงสุด 500 หมายเลย ต่อ 1 bulk request
to	Strings	หมายเลขปลายทาง ต้องเป็น international format (ตัวอย่าง: 66639393544)
messageId (optional)	String(200)	เป็นรหัสที่ไม่ซ้ำกันบ่งบอกการส่งของแต่ละข้อความ
text	String(1600)	ข้อความที่ต้องการจะส่งหาหมายเลขผู้รับ
shorturl (optional)	String (y or n)	กำหนดให้ใช้งานฟังก์ชั่นย่อ URL ในข้อความด้วยค่า "y"
notifyUrl (optional)	String (150)	ท่านสามารถกำหนด URL บน callback server ที่ต้องการ ให้ส่งรายงานผล (Delivery report) โดยสามารถกำหนด API สำหรับรับ Callback ตามลิ้งค์นี้ Send Callback
notifyContentType (optional)	String (50)	กำหนด content type ของ รายงานผล Delivery report เป็น application/json
sendAt (optional)	DateTime	วันที่และเวลาที่ต้องการให้ข้อความถูกส่ง สามารถใช้ สำหรับตั้งเวลาการส่งล่วงหน้า รูปแบบ Date Time Format: 01/01/2020 09:00
callbackData (optional)	String (1000)	ระบุค่าที่ต้องการส่งกลับ เมื่อระบุ notifyUrl จะส่งค่า callbackData นี้กลับไป

ตัวอย่าง Request JSON

{
    "bulkId": "75108ada-ffa3-4577-8ff1-db2a4690ccbd",
    "messages": [
        {
            "from": "ANTS",
            "destinations": [
                {
                    "to": "66123456789",
                    "messageId": "25501288135972440649"
                }
            ],
            "text": "สวัสดี Hello Word",
            "shorturl" : "n",
            "notifyUrl": "https://testSend",
            "notifyContentType": "application/json",
            "sendAt": "01/01/2020 09:00",
            "callbackData":"ANTS Data"
        }
    ]
 }

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
bulkId	String	รหัสการส่งในแต่ละครั้ง
detail	Array	ชุดค่าการตอบกลับ
messageId	String	รหัสอ้างอิงของแต่ละหมายเลข ในการส่งแต่ละครั้ง
to	String	หมายเลขที่ได้รับข้อความ
from	String	Sender name ที่ส่ง
credit	Decimal	จำนวน credit ที่ใช้
shorturl	String	ใช้งานฟังก์ชั่นย่อ URL ในข้อความ
status	Object	ชุดข้อมูลสถานะ
code	String	รหัสสถานะการตอบกลับ
name	String	ชื่อสถานะการตอบกลับ
description	String	รายละเอียดสถานะการตอบกลับ

ตัวอย่าง Response JSON

{
    "bulkid": "75108ada-ffa3-4577-8ff1-db2a4690ccbd",
    "detail": [
        {
            "messageId": "25501288135972440649",
            "to": "66123456789",
            "from": "ANTS",
            "credit": 1.00,
            "shorturl": "N",
            "status": {
                "code": "101",
                "name": "PENDING",
                "description": "Pending -Message has been accepted by the system"
            }
        }
    ]
}