สถานะ SMS
การค้นหา
รายการสถานะ SMS ที่ส่งโดยผู้ใช้
คุณสามารถดำเนินการค้นหาในรายการนี้ได้
URL
https://sms.api.engagelab.cc/v1/status
https://sms.api.engagelab.cc/v1/status
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
คำอธิบายพารามิเตอร์
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| offset | string | No | ตำแหน่งเริ่มต้นของการค้นหา, ช่วง [0-], ค่าเริ่มต้นคือ 0 |
| limit | string | No | จำนวนการค้นหา, ช่วง [0-100], ค่าเริ่มต้นคือ 100 |
| time_zone | string | No | เขตเวลา ค่าเริ่มต้น: +8 |
| send_date | string | Yes | วันที่ส่ง, รูปแบบ: yyyy-mm-dd |
| phone | string | No | หมายเลขโทรศัพท์ |
| sms_ids | string | No | SMS IDs ที่ส่งสำเร็จ, หลาย sms_ids คั่นด้วย ;, รองรับสูงสุด 10 |
| msg_type | string | No | ประเภท SMS, 2 หมายถึง SMS ระหว่างประเทศ |
| sms_user | string | No | SMS_USER เฉพาะของลูกค้า |
| template_id | string | No | Template ID |
| label_id | string | No | Label ID |
| status | string | No | 1 ส่งแล้ว, 2 ส่งถึงแล้ว, 3 รอการรับ, 4 ประมวลผลล้มเหลว, 5 การส่งล้มเหลว |
| sub_status | string | No | สถานะย่อย |
หมายเหตุ:
- รองรับการค้นหาข้อมูลรายละเอียดของวันที่เฉพาะภายใน 6 เดือนที่ผ่านมา
- บันทึกที่ได้จากการค้นหาแต่ละครั้งจะถูกแคชไว้ 10 นาทีตามพารามิเตอร์ที่ผู้ใช้ระบุ
- API นี้จำกัด sms_user แต่ละรายให้เรียกใช้งานได้ 60 ครั้งต่อนาที
ตัวอย่างคำขอ
curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| พารามิเตอร์ | คำอธิบาย |
|---|---|
| phone | หมายเลขโทรศัพท์ |
| sms_id | SMS ID |
| msg_type | ประเภท SMS |
| sms_user | SMS_USER |
| template_id | Template ID |
| template_name | ชื่อเทมเพลต |
| status | 1 ส่งแล้ว, 2 ส่งถึงแล้ว, 3 รอการรับ, 4 ประมวลผลล้มเหลว, 5 การส่งล้มเหลว |
| status_desc | คำอธิบายสถานะการส่ง SMS, แบ่งเป็น 5 สถานะ: Request, Delivered, Processing Failed, Sending Failed, Pending Receipt |
| sub_status | สถานะย่อย |
| sub_status_desc | คำอธิบายสถานะย่อย, ดูตารางด้านล่าง |
| request_time | เวลาการร้องขอ |
| update_time | เวลาอัปเดต |
| response_message | บันทึกการส่ง |
รหัสสถานะประมวลผลล้มเหลวและคำอธิบาย:
| sub_status | คำอธิบายสถานะย่อย |
|---|---|
| 410 | ประมวลผลล้มเหลว - รายการบล็อกทั่วโลก |
| 420 | ประมวลผลล้มเหลว - รายการบล็อกท้องถิ่น |
| 430 | ประมวลผลล้มเหลว - ยกเลิกการสมัคร |
| 440 | ประมวลผลล้มเหลว - ตัวกรองคำสำคัญ |
| 450 | ประมวลผลล้มเหลว - ข้อผิดพลาดในการแทนที่ตัวแปร |
| 460 | ประมวลผลล้มเหลว - เนื้อหาไม่เป็นไปตามข้อกำหนด |
| 470 | ประมวลผลล้มเหลว - เกินขีดจำกัดความถี่ |
| 480 | ประมวลผลล้มเหลว - อื่นๆ |
รหัสสถานะการส่งล้มเหลวและคำอธิบาย:
| sub_status | คำอธิบายสถานะย่อย |
|---|---|
| 500 | การส่งล้มเหลว - หมายเลขว่างเปล่า |
| 510 | การส่งล้มเหลว - ถูกระงับ |
| 520 | การส่งล้มเหลว - รายการบล็อก |
| 530 | การส่งล้มเหลว - สายไม่ว่าง |
| 540 | การส่งล้มเหลว - ไม่มีการตอบรับ |
| 550 | การส่งล้มเหลว - ถูกบล็อก |
| 560 | การส่งล้มเหลว - โทรศัพท์ขัดข้อง |
| 570 | การส่งล้มเหลว - อยู่นอกพื้นที่ให้บริการ |
| 580 | การส่งล้มเหลว - ปิดเครื่อง |
| 590 | การส่งล้มเหลว - อื่นๆ |
ตัวอย่างการตอบกลับ
{
"result": [{
"sms_id":"***_**_**_**_**$**",
"msg_type": 2,
"phone": "+16235217",
"request_time": "2017-02-19 00:21:20",
"response_message": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
{
"result": [{
"sms_id":"***_**_**_**_**$**",
"msg_type": 2,
"phone": "+16235217",
"request_time": "2017-02-19 00:21:20",
"response_message": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
