Mencabut pesan agen yang telah dikirim, tetapi belum terkirim.
Jika platform RCS untuk Bisnis berhasil mencabut pesan, pesan tersebut akan dihapus dari antrean pesan pengguna dan tidak pernah dikirim (200 OK).
Respons 404 Not Found berarti upaya pencabutan telah gagal karena pesan telah dikirim.
Ada kemungkinan kecil bahwa agen dapat memulai pencabutan saat platform RCS untuk Bisnis sedang dalam proses mengirimkan pesan. Dalam kasus yang jarang terjadi ini, agen menerima peristiwa pengguna DELIVERED untuk pesan tersebut segera setelah memulai permintaan pencabutan.
Permintaan HTTP
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
URL ini menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter | |
|---|---|
name |
"phones/{E.164}/agentMessages/{messageId}", dengan {E.164} adalah nomor telepon pengguna dalam format E.164 dan {messageId} adalah ID pesan agen yang ditetapkan agen yang harus dibatalkan. Misalnya, dengan nomor telepon AS +1-222-333-4444 dan pesan agen dengan ID "12345xyz", endpoint yang dihasilkan adalah https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz. |
Parameter kueri
| Parameter | |
|---|---|
agentId |
Wajib. ID unik agen. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons adalah objek JSON kosong.
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/rcsbusinessmessaging
Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.