การส่งที่เกี่ยวข้อง
ส่ง
ส่งเทมเพลต SMS ไปยังผู้ใช้หนึ่งคนหรือมากกว่า
URL
https://sms.api.engagelab.cc/v1/send
https://sms.api.engagelab.cc/v1/send
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
ประเภทเนื้อหา
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำร้องขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
คำอธิบายพารามิเตอร์
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| from | string | No | ชื่อผู้ส่ง รองรับ 3-11 ตัวอักษร ใช้ได้เฉพาะตัวอักษรและตัวเลข ค่าเริ่มต้นเป็นค่าว่าง การแสดงจริงอาจแตกต่างกัน |
| to | array | Yes | รายการหมายเลขโทรศัพท์ สูงสุด 1000 หมายเลข |
| body | object | Yes | การตั้งค่าข้อความ SMS |
| template_id | int | Yes | รหัสเทมเพลต |
| msg_type | int | No | ประเภทธุรกิจ 2 หมายถึง SMS ระหว่างประเทศ ค่าเริ่มต้นคือ 2 |
| label_id | int | No | ป้ายกำกับ SMS |
| vars | object | No | ตัวแปร ขนาดสูงสุด 1MB |
| custom_args | object | No | ฟิลด์ที่กำหนดเองโดยลูกค้า ขนาดสูงสุด 1KB |
| request_id | string | No | รหัสคำร้องขอสำหรับการส่งนี้ สูงสุด 128 ตัวอักษร |
หมายเหตุ:
varsใช้สำหรับการแทนค่าตัวแปรในเนื้อหา SMS มีรูปแบบเป็น JSON object:{"varname":"value1"}โดยที่varnameคือตัวแปรในเนื้อหา SMS- ตัวอย่างเนื้อหา SMS: "Welcome to %sp% SMS service." ค่า
varsที่สอดคล้อง:{"sp":"engagelab"}หลังจากแทนค่า: "Welcome to engagelab SMS service."- ค่าทุกค่าภายใน
varsไม่สามารถเกิน 16 ตัวอักษรตามค่าเริ่มต้น ต้องเป็นสตริง และไม่สามารถมีลิงก์ HTTP (ติดต่อฝ่ายบริการลูกค้าสำหรับข้อกำหนดพิเศษ)- ระบบจะแทนค่าตัวแปรในเทมเพลต SMS ด้วยพารามิเตอร์ใน
varsและหมายเลขโทรศัพท์ทั้งหมดจะได้รับเนื้อหาที่แทนค่าเดียวกันcustomer_argsเป็นเนื้อหาที่กำหนดเองโดยลูกค้า ซึ่งจะถูกส่งกลับไปยังลูกค้าในข้อมูล SMSHook ถัดไปrequest_idใช้เพื่อป้องกันการส่งซ้ำ มีผลเป็นเวลา 1 ชั่วโมง หากส่งซ้ำภายใน 1 ชั่วโมง ระบบจะส่งผลลัพธ์คำร้องขอก่อนหน้า
ตัวอย่างคำร้องขอ
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
'week':"Tuesday"
}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
'week':"Tuesday"
}
}
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| success_count | จำนวนการส่งที่สำเร็จ |
| sms_ids | รายการรหัสของ SMS ที่ส่งสำเร็จ |
| failed_count | จำนวนการส่งที่ล้มเหลว |
| failed_items | รายการหมายเลขโทรศัพท์ที่ล้มเหลวและเหตุผลที่ล้มเหลว |
| phone | หมายเลขโทรศัพท์ |
| message | เหตุผลที่ล้มเหลว |
| request_id | ฟิลด์ที่กำหนดเองโดยลูกค้า |
| custom_args | รหัสคำร้องขอสำหรับการส่งนี้ |
ตัวอย่างการตอบกลับ
การตอบกลับ-สำเร็จ
HTTP Status: 200
//ตัวอย่างการตอบกลับสำเร็จ
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"]
"request_id":"123"
}
// ตัวอย่างการตอบกลับสำเร็จบางส่วน
{
"code": 41031,
"message": "partial success"，
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123" ,
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
//ตัวอย่างการตอบกลับสำเร็จ
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"]
"request_id":"123"
}
// ตัวอย่างการตอบกลับสำเร็จบางส่วน
{
"code": 41031,
"message": "partial success"，
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123" ,
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
// example of failed return results
{
"code": 32002,
"message": "Invalid phone number format"
}
// example of failed return results
{
"code": 32002,
"message": "Invalid phone number format"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
