Method: phones.agentEvents.create

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

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

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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://www.rfc-editor.org/info/rfc9562 تعریف شده است. پلاتفرم «RCS ویژه کسب‌وکارها» هر پیام عاملی را که با شناسه‌ای ارسال شده باشد که قبلاً توسط پیام یا رویداد قبلی ارسال‌شده از همان عامل استفاده شده است نادیده می‌گیرد.
agentId

string

الزامی. شناسه یکتای نماینده.

متن درخواست

بدنه درخواست حاوی نمونه‌ای از AgentEvent است.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه جدیدی از AgentEvent است.

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

به گستره OAuth زیر نیاز دارد:

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

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