Message Recall API
ชั้น API รองรับฟีเจอร์การเรียกคืนข้อความ
การยืนยันตัวตน
สำหรับรายละเอียด โปรดดูที่ส่วน วิธีการยืนยันตัวตน ในภาพรวม REST API
การเรียกคืนข้อความ
Endpoint
DELETE v4/push/withdraw/{msg_id}
ข้อจำกัด
- การเรียกคืนรองรับเฉพาะข้อความภายในหนึ่งวันเท่านั้น
- ไม่รองรับการเรียกคืนซ้ำ
คำอธิบายพารามิเตอร์คำขอ
ชื่อ | จำเป็น | คำอธิบาย |
---|---|---|
msg_id | Y | msg_id ที่ส่งคืนโดยการส่งข้อความ |
ตัวอย่างคำขอ
ส่วนหัวของคำขอ
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (base64 auth string)
Accept: application/json
DELETE /v4/push/withdraw/1828256757
Authorization: Basic (base64 auth string)
Accept: application/json
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างการตอบกลับ
การตอบกลับที่สำเร็จ
< HTTP/1.1 200 OK
< Content-Type: application/json
{
"request_id": "",
"msg_id": "1180003"
}
< HTTP/1.1 200 OK
< Content-Type: application/json
{
"request_id": "",
"msg_id": "1180003"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การตอบกลับที่ล้มเหลว
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
รหัส | HTTP | คำอธิบาย | ข้อความข้อผิดพลาด | คำอธิบายโดยละเอียด |
---|---|---|---|---|
None | 200 | การส่งคืนสำเร็จ | nil | รหัสสถานะสำเร็จ |
21003 | 400 | ข้อผิดพลาดของพารามิเตอร์ | ค่า Parameter ไม่ถูกต้อง พร้อมข้อมูลข้อผิดพลาดเฉพาะ | ค่า Parameter ไม่ถูกต้อง พร้อมข้อมูลข้อผิดพลาดเฉพาะ |