Method: phones.agentMessages.delete

Mencabut pesan agen yang telah dikirim tetapi belum terkirim.

Jika platform RBM berhasil mencabut pesan, maka pesan itu akan dihapus dari antrean pesan pengguna dan tidak pernah dikirimkan.

Metode ini segera menampilkan 200 OK, terlepas dari apakah pesan berhasil dicabut atau tidak.

Ada kemungkinan kecil agen dapat memulai pencabutan saat platform RBM sedang dalam proses mengirimkan pesan. Dalam kasus yang jarang terjadi ini, agen akan menerima peristiwa pengguna PENGIRIMAN untuk pesan segera setelah memulai permintaan pembatalan.

Permintaan HTTP

DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

"phones/{E.164}/agentMessages/{messageId}", dengan {E.164} adalah nomor telepon pengguna dalam format E.164 dan {messageId} adalah ID yang ditetapkan oleh agen untuk pesan agen yang harus dicabut. 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

string

Wajib. ID unik agen.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.