Method: phones.agentMessages.delete

پیام عاملی را که ارسال شده اما هنوز تحویل داده نشده است باطل می کند.

اگر پلتفرم RBM با موفقیت یک پیام را لغو کند، پیام از صف پیام کاربر حذف می شود و هرگز تحویل داده نمی شود.

این روش فوراً 200 OK را برمی‌گرداند، چه پیام با موفقیت لغو شده باشد یا نه.

در حالی که پلتفرم RBM در حال تحویل پیام است، احتمال کمی وجود دارد که عامل شروع به ابطال کند. در این موارد نادر، نماینده بلافاصله پس از شروع درخواست ابطال، یک رویداد کاربر DELIVERED برای پیام دریافت می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

ضروری. شناسه منحصر به فرد عامل.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.