API Penarikan Pesan
API ini mendukung fitur penarikan (withdraw) pesan.
Autentikasi
Untuk detail, silakan lihat bagian Metode Autentikasi pada REST API Overview.
Penarikan Pesan
Endpoint
DELETE v4/push/withdraw/{msg_id}
Batasan
- Penarikan hanya didukung untuk pesan yang dikirim dalam waktu satu hari.
- Tidak mendukung penarikan ganda.
Deskripsi Parameter Permintaan
| Nama | Wajib | Deskripsi |
|---|---|---|
| msg_id | Ya | msg_id yang didapat dari hasil push pesan |
Contoh Permintaan
Header Permintaan
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
Tampilkan blok kode ini di jendela mengambang
Contoh Respons
Respons Berhasil
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"
}
Tampilkan blok kode ini di jendela mengambang
Respons Gagal
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
Tampilkan blok kode ini di jendela mengambang
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
{
"error": {
"code": 21003,
"message": "Parameter value is invalid,msg_id not exist"
}
}
Tampilkan blok kode ini di jendela mengambang
Kode Error
| Kode | HTTP | Deskripsi | Pesan Error | Penjelasan Detail |
|---|---|---|---|---|
| None | 200 | Pengembalian sukses | nil | Status sukses |
| 21003 | 400 | Parameter error | Parameter value is invalid, beserta info error | Nilai parameter tidak valid, beserta informasi spesifik |
