Method: phones.agentEvents.create

یک رویداد را از عامل به یک کاربر ارسال می‌کند.

رویدادهای عامل می‌توانند برای نشان دادن اینکه عامل پیامی از کاربر خوانده است یا اینکه عامل در حال تایپ کردن است (که یک عنصر انسانی را به تجربه RCS برای کسب و کار اضافه می‌کند) استفاده شوند. اگر کاربر RCS را فعال نکرده باشد، پلتفرم RCS برای کسب و کار خطای NOT_FOUND (HTTP 404) را برمی‌گرداند. اگر کاربر RCS را فعال کرده باشد اما در حال حاضر قابل دسترسی نباشد، پلتفرم پاسخ 200 OK را برمی‌گرداند و تحویل را بر اساس نوع رویداد مدیریت می‌کند. رویدادهای عامل تا 30 روز در صف ذخیره و ارسال قرار می‌گیرند و پس از آنلاین شدن مجدد کاربر تحویل داده می‌شوند. فقط رویدادهای IS_TYPING زودگذر هستند و در صف قرار نمی‌گیرند.

برخلاف پیام‌های عامل، رویدادهای عامل پس از ارسال قابل لغو نیستند.

درخواست HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
parent

string

"phones/{E.164}"، که در آن {E.164} شماره تلفن کاربر با فرمت E.164 است. برای مثال، برای کاربری با شماره تلفن ایالات متحده +1-222-333-4444، مقدار phones/+12223334444 خواهد بود و نقطه پایانی حاصل https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents خواهد بود.

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

پارامترها
eventId

string

شناسه رویداد، که توسط عامل اختصاص داده شده است. این باید یک UUID باشد، همانطور که در https://tools.ietf.org/html/rfc4122 تعریف شده است. پلتفرم RCS for Business هر پیام عاملی را که با شناسه‌ای ارسال شود که توسط پیام یا رویداد قبلی ارسال شده از همان عامل استفاده شده است، نادیده می‌گیرد.

agentId

string

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

درخواست بدنه

بدنه درخواست شامل یک نمونه از AgentEvent است.

بدنه پاسخ

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

دامنه‌های مجوز

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .