Method: phones.agentMessages.delete

پیام اپراتوری که ارسال شده اما هنوز تحویل داده نشده است را لغو می‌کند.

اگر پلتفرم RCS for Business با موفقیت پیامی را لغو کند، آن پیام از صف پیام‌های کاربر حذف شده و هرگز تحویل داده نمی‌شود (200 OK).

پاسخ ۴۰۴ «یافت نشد» به این معنی است که تلاش برای لغو ناموفق بوده است زیرا پیام تحویل داده شده است.

احتمال کمی وجود دارد که عامل در حین ارسال پیام توسط پلتفرم RCS for Business، لغو را آغاز کند. در این موارد نادر، عامل اندکی پس از شروع درخواست لغو، یک رویداد کاربری «تحویل داده شد» برای پیام دریافت می‌کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در 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 .