رویدادی را از نماینده به کاربر ارسال می کند.
رویدادهای عامل را می توان برای نشان دادن اینکه عامل پیامی از کاربر خوانده است یا اینکه عامل در حال تایپ است (که یک عنصر انسانی را به تجربه RBM اضافه می کند) استفاده می شود. اگر RBM نتواند به کاربر دسترسی پیدا کند، پلتفرم RBM 404 NOT_FOUND
را برمیگرداند.
برخلاف پیامهای نماینده، رویدادهای نماینده پس از ارسال قابل لغو نیستند.
درخواست HTTP
POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
parent | "phones/{E.164}"، که در آن {E.164} شماره تلفن کاربر در قالب E.164 است. به عنوان مثال، برای کاربری با شماره تلفن ایالات متحده +1-222-333-4444، مقدار phones/+12223334444 و نقطه پایانی https://rcsbusinessmessaging.googleapis.com/v1/phones/+ خواهد بود. 12223334444/agentEvents . |
پارامترهای پرس و جو
مولفه های | |
---|---|
eventId | شناسه رویداد، تعیین شده توسط نماینده. این باید یک UUID باشد، همانطور که در https://tools.ietf.org/html/rfc4122 تعریف شده است. پلتفرم RBM هر پیام عاملی را که با شناسه ارسال شده توسط پیام یا رویداد قبلی ارسال شده از همان عامل استفاده شده است، نادیده می گیرد. |
agentId | ضروری. شناسه منحصر به فرد عامل. |
درخواست بدن
بدنه درخواست شامل یک نمونه از AgentEvent
است.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه جدید از AgentEvent
است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/rcsbusinessmessaging
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.