Method: phones.agentMessages.delete

لإلغاء رسالة وكيل تم إرسالها ولكن لم يتم تسليمها بعد.

إذا أبطلت منصة RBM إحدى الرسائل بنجاح، سيتم حذف الرسالة من قائمة انتظار الرسائل لدى المستخدم ولن يتم تسليمها أبدًا.

تعرض هذه الطريقة على الفور القيمة 200 OK، سواء تم إبطال الرسالة بنجاح أم لا.

هناك احتمال ضئيل أن يبدأ الوكيل عملية إبطال الرمز أثناء إرسال الرسالة من خلال منصة RBM. في هذه الحالات النادرة، يتلقى الوكيل حدث مستخدم "DELIVERED" للرسالة بعد وقت قصير من بدء طلب الإبطال.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
name

string

"phones/{E.164}/agentMessages/{messageId}"، حيث يشير {E.164} إلى رقم هاتف المستخدم بالتنسيق E.164 و{messageId} هو المعرّف الذي عينه الوكيل لرسالة الوكيل التي ينبغي إبطالها. على سبيل المثال، في حال استخدام رقم الهاتف 1-222-333-4444 في الولايات المتحدة ورسالة وكيل تتضمّن المعرّف "12345xyz"، تكون نقطة النهاية الناتجة هي https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.

مَعلمات طلب البحث

المعلمات
agentId

string

مطلوب. المعرّف الفريد للوكيل

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة هو عنصر JSON فارغ.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.