การสกัด SMS

URL

https://sms.api.engagelab.cc/v1/bounces

              
              https://sms.api.engagelab.cc/v1/bounces

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET

GET

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัว

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	ใช่	Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์การค้นหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
offset	int	ไม่	ตำแหน่งเริ่มต้น, [0-], ค่าเริ่มต้นคือ 0
limit	int	ไม่	จำนวนการค้นหา, [0-100], ค่าเริ่มต้นคือ 100
phone	string	ไม่	หมายเลขโทรศัพท์
start_date	string	ใช่	วันที่เริ่มต้น, รูปแบบ `yyyy-MM-dd`
end_date	string	ใช่	วันที่สิ้นสุด, รูปแบบ `yyyy-MM-dd`

หมายเหตุ:

ช่วงระหว่าง start_date และ end_date ต้องไม่เกิน 90 วัน

ตัวอย่างการร้องขอ

curl -X GET "https://sms.api.engagelab.cc/v1/bounces" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/bounces" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
phone	หมายเลขโทรศัพท์
bounce_type	สถานะการสกัด SMS
msg_type	ประเภท SMS, 2 หมายถึง SMS ระหว่างประเทศ
bounce_time	เวลาการสกัด SMS
expire_time	เวลาหมดอายุการสกัด SMS
reason	เหตุผลของการสกัด SMS

bounce_type รหัสประเภทและคำอธิบายที่เกี่ยวข้อง

ประเภทการสกัด	คำอธิบาย
500	ส่งล้มเหลว, หมายเลขไม่มีอยู่จริง
510	ส่งล้มเหลว, หมายเลขถูกระงับ
520	ส่งล้มเหลว, หมายเลขอยู่ในบัญชีดำ
530	ส่งล้มเหลว, หมายเลขไม่ว่าง
540	ส่งล้มเหลว, ไม่มีการตอบกลับจากหมายเลข
550	ส่งล้มเหลว, เนื้อหาเทมเพลตถูกสกัด
560	ส่งล้มเหลว, ข้อผิดพลาดของอุปกรณ์มือถือ
570	ส่งล้มเหลว, หมายเลขไม่อยู่ในพื้นที่ให้บริการ
580	ส่งล้มเหลว, อุปกรณ์มือถือปิดเครื่อง
590	ส่งล้มเหลว, เหตุผลอื่นๆ
410	รายการสกัดทั่วโลก
411	รายการสกัดทั่วโลกที่กำหนดเอง
420	รายการสกัดในพื้นที่
421	รายการสกัดในพื้นที่ที่กำหนดเอง
430	ยกเลิกการสมัคร
440	การกรองคำสำคัญ
450	ข้อผิดพลาดในการแทนที่ตัวแปร
460	ความยาวตัวแปรเกินขีดจำกัด
470	ข้อยกเว้นการเข้ารหัส (หมายเหตุ: ข้อยกเว้นการเข้ารหัสถูกรวมกับ 460, ตอนนี้ 470 หมายถึงเกินขีดจำกัดความถี่)
480	ประเภทการส่งที่ไม่รองรับ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": [ { "phone": "008613681312917", "bounce_type": 421, "bounce_time": "2023-08-04T16:47:02+0800", "expire_time": "2023-08-08T00:00:00+0800", "msg_type": 2, "reason": "Customize local interception list" } ], "total": 1, "count": 1 }

              
              {
    "result": [
        {
            "phone": "008613681312917",
            "bounce_type": 421,
            "bounce_time": "2023-08-04T16:47:02+0800",
            "expire_time": "2023-08-08T00:00:00+0800",
            "msg_type": 2,
            "reason": "Customize local interception list"
        }
    ],
    "total": 1,
    "count": 1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การลบ

URL

https://sms.api.engagelab.cc/v1/bounces

              
              https://sms.api.engagelab.cc/v1/bounces

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE

              
              DELETE

โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json

              
              application/json

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัว

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	ใช่	Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์ในเนื้อหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
phone	string	ใช่	หมายเลขโทรศัพท์
start_date	string	ใช่	วันที่เริ่มต้น, รูปแบบ `yyyy-MM-dd`
end_date	string	ใช่	วันที่สิ้นสุด, รูปแบบ `yyyy-MM-dd`

หมายเหตุ:

ช่วงระหว่าง start_date และ end_date ต้องไม่เกิน 90 วัน

ตัวอย่างการร้องขอ

curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces" --data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}' --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces" 
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
count	จำนวนการสกัดที่ถูกลบ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย