منبع: AgentMessage
پیامی که از طرف نماینده برای کاربر ارسال میشود.
| نمایش JSON |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| فیلدها | |
|---|---|
name | این فیلد توسط پلتفرم RCS for Business تنظیم شده است. هنگام ایجاد پیام اپراتور، آن را وارد نکنید. این فیلد "phones/{E.164}/agentMessages/{messageId}" را مشخص میکند، که در آن {E.164} شماره تلفن کاربر با فرمت E.164 و {messageId} شناسه اختصاص داده شده توسط اپراتور برای پیام اپراتور است. |
sendTime | این فیلد توسط پلتفرم RCS for Business تنظیم شده است. هنگام ایجاد پیام برای اپراتور، آن را وارد نکنید. این فیلد زمان ارسال پیام به کاربر را تعیین میکند. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
contentMessage | محتوای پیام نماینده. |
messageTrafficType | نوع ترافیک پیام |
| |
expireTime | اختیاری. مهر زمان بر حسب UTC که نشان میدهد این منبع منقضی شده است. این مقدار در صورت تنظیم یا تنظیم فیلد TTL در خروجی ارائه میشود. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
ttl | اختیاری. فقط ورودی. مدت زمانی که پیام قبل از لغو خودکار، باقی میماند. مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' |
پیام محتوای عامل
محتوای پیامی که از طرف نماینده به کاربر ارسال میشود.
| نمایش JSON |
|---|
{ "suggestions": [ { object ( |
| فیلدها | |
|---|---|
suggestions[] | فهرستی از پاسخها و اقدامات پیشنهادی که به صورت فهرستی از تراشههای پیشنهادی پس از پیام عامل مرتبط ظاهر میشوند. حداکثر ۱۱ پیشنهاد. این تراشهها فقط زمانی نمایش داده میشوند که پیام مربوط به اپراتور، جدیدترین پیام در مکالمه باشد (شامل پیامهای اپراتور و کاربر). کاربر میتواند روی یک پاسخ پیشنهادی ضربه بزند تا پاسخ متنی را برای اپراتور ارسال کند یا روی یک اقدام پیشنهادی ضربه بزند تا یک اقدام بومی در دستگاه آغاز شود. حداکثر ۱۱ پیشنهاد. |
content فیلد Union. content پیام عامل میتواند فقط یکی از موارد زیر باشد: | |
text | متن با کد UTF-8 کدگذاری شده است. حداکثر 3072 کاراکتر. |
fileName | نام منحصر به فرد یک فایل. پلتفرم RCS for Business هنگام آپلود فایل توسط یک عامل، نام فایل را برمیگرداند. در زیر، uploadedRbmFile منسوخ شده است. |
uploadedRbmFile | شامل شناسههایی برای یک فایل و تصویر بندانگشتی است که در سرور RCS for Business بارگذاری و ارائه شدهاند. |
richCard | یک کارت غنی مستقل. |
contentInfo | اطلاعات مربوط به یک فایل، شامل آدرس اینترنتی (URL) فایل و آدرس اینترنتی تصویر بندانگشتی فایل. پلتفرم RCS for Business محتوا را از یک حافظه پنهان ارائه میدهد، اما یک عامل میتواند پلتفرم RCS for Business را مجبور کند نسخه جدیدی از محتوا را دریافت کرده و حافظه پنهان را بهروزرسانی کند. |
فایل Rbm آپلود شده
پیامی حاوی اطلاعات فایل و تصویر بندانگشتی
| نمایش JSON |
|---|
{ "fileName": string, "thumbnailName": string } |
| فیلدها | |
|---|---|
fileName | نام فایل، که توسط پلتفرم RCS for Business هنگام آپلود فایل برگردانده شده است. |
thumbnailName | نام تصویر کوچک، که توسط پلتفرم RCS for Business هنگام آپلود تصویر کوچک برگردانده شده است. |
ریچکارت
یک کارت غنی مستقل یا مجموعهای از کارتهای غنی که از طرف نماینده به کاربر ارسال میشود.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
card میدانی اتحادیه. کارت مستقل یا کارتهای گردان. card میتواند فقط یکی از موارد زیر باشد: | |
carouselCard | چرخ فلک کارتها. |
standaloneCard | کارت مستقل. |
کارت چرخ فلک
چرخ فلک کارتها.
| نمایش JSON |
|---|
{ "cardWidth": enum ( |
| فیلدها | |
|---|---|
cardWidth | عرض کارتها در چرخ فلک. |
cardContents[] | فهرست محتویات هر کارت در چرخ و فلک. یک چرخ و فلک میتواند حداقل ۲ کارت و حداکثر ۱۰ کارت داشته باشد. |
عرض کارت چرخ فلک
عرض کارتها در چرخ فلک.
| انومها | |
|---|---|
CARD_WIDTH_UNSPECIFIED | مشخص نشده است. |
SMALL | ۱۲۰ DP. توجه داشته باشید که نمیتوان از رسانههای بلند استفاده کرد. |
MEDIUM | ۲۳۲ دی پی. |
محتوای کارت
محتوای کارت
| نمایش JSON |
|---|
{ "title": string, "description": string, "media": { object ( |
| فیلدها | |
|---|---|
title | (اختیاری) عنوان کارت. حداکثر ۲۰۰ کاراکتر. |
description | (اختیاری) شرح کارت. حداکثر ۲۰۰۰ کاراکتر. |
media | (اختیاری) رسانه (تصویر، GIF، ویدیو، PDF) برای قرار دادن در کارت. |
suggestions[] | (اختیاری) فهرست پیشنهاداتی که باید در کارت ذکر شوند. حداکثر ۴ پیشنهاد. |
رسانه
یک فایل رسانهای درون یک کارت غنی.
| نمایش JSON |
|---|
{ "height": enum ( |
| فیلدها | |
|---|---|
height | ارتفاع رسانه درون یک کارت غنی با طرح عمودی. برای یک کارت مستقل با طرح افقی، ارتفاع قابل تنظیم نیست و این فیلد نادیده گرفته میشود. |
content فیلد Union. content محتوای رسانهای میتواند فقط یکی از موارد زیر باشد: | |
fileName | نام منحصر به فرد فایل، که توسط پلتفرم RCS for Business هنگام آپلود فایل برگردانده میشود. در زیر به نفع uploadedRbmFile منسوخ شده است. |
uploadedRbmFile | شامل شناسههایی برای یک فایل و تصویر بندانگشتی است که در سرور RCS for Business بارگذاری و ارائه شدهاند. |
contentInfo | اطلاعات مربوط به یک فایل، شامل آدرس اینترنتی (URL) فایل و آدرس اینترنتی تصویر بندانگشتی فایل. پلتفرم RCS for Business محتوا را از یک حافظه پنهان ارائه میدهد، اما یک عامل میتواند پلتفرم RCS for Business را مجبور کند نسخه جدیدی از محتوا را دریافت کرده و حافظه پنهان را بهروزرسانی کند. |
اطلاعات محتوا
پیامی که حاوی اطلاعات محتوایی است.
| نمایش JSON |
|---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
| فیلدها | |
|---|---|
fileUrl | آدرس اینترنتی (URL) فایل که برای عموم قابل دسترسی باشد. پلتفرم RCS for Business نوع MIME فایل را از فیلد نوع محتوا در هدرهای HTTP هنگام دریافت فایل توسط پلتفرم تعیین میکند. فیلد نوع محتوا باید در پاسخ HTTP از URL موجود و دقیق باشد. حداکثر اندازه فایل توصیه شده ۱۰۰ مگابایت است. توجه: تغییر مسیر در آدرسهای فایل پشتیبانی نمیشود. در صورت نیاز به تغییر مسیر، لطفاً از CreateFileRequest استفاده کنید. |
thumbnailUrl | (اختیاری، فقط برای فایلهای تصویری، صوتی و ویدیویی) آدرس اینترنتی (URL) تصویر بندانگشتی که برای عموم قابل دسترسی باشد. حداکثر اندازه ۱۰۰ کیلوبایت. اگر نشانی اینترنتی تصویر کوچک را ارائه ندهید، پلتفرم RCS for Business تا زمانی که دستگاه کاربر فایل را دانلود کند، یک تصویر کوچک خالی نمایش میدهد. بسته به تنظیمات کاربر، ممکن است فایل به طور خودکار دانلود نشود و ممکن است لازم باشد کاربر روی دکمه دانلود ضربه بزند. توجه: تغییر مسیر در آدرسهای فایل پشتیبانی نمیشود. در صورت نیاز به تغییر مسیر، لطفاً از CreateFileRequest استفاده کنید. |
forceRefresh | در صورت تنظیم، پلتفرم RCS for Business فایل و تصویر بندانگشتی را از URL های مشخص شده دریافت میکند، حتی اگر پلتفرم کپیهایی از فایل (و/یا تصویر بندانگشتی) را در حافظه پنهان داشته باشد. |
رسانه.ارتفاع
ارتفاع رسانه
| انومها | |
|---|---|
HEIGHT_UNSPECIFIED | مشخص نشده است. |
SHORT | ۱۱۲ دی پی. |
MEDIUM | ۱۶۸ دی پی. |
TALL | ۲۶۴ DP. وقتی عرض کارت روی کوچک تنظیم شده باشد، برای چرخ و فلکهای کارت غنی در دسترس نیست. |
پیشنهاد
یک پاسخ پیشنهادی یا یک اقدام پیشنهادی که در یک کارت غنی یا در یک لیست تراشههای پیشنهادی گنجانده شده است.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
option فیلد مشترک. یک پاسخ پیشنهادی یا یک اقدام پیشنهادی. option میتواند فقط یکی از موارد زیر باشد: | |
reply | کاربران میتوانند روی پاسخ پیشنهادی ضربه بزنند تا پاسخ متنی را برای اپراتور ارسال کنند. |
action | کاربران میتوانند روی یک اقدام پیشنهادی ضربه بزنند تا اقدام بومی مربوطه را در دستگاه آغاز کنند. |
پاسخ پیشنهادی
وقتی روی آن ضربه زده شود، پاسخ متنی را برای اپراتور ارسال میکند.
| نمایش JSON |
|---|
{ "text": string, "postbackData": string } |
| فیلدها | |
|---|---|
text | متنی که در پاسخ پیشنهادی نمایش داده میشود و وقتی کاربر روی آن ضربه میزند، برای اپراتور ارسال میشود. حداکثر ۲۵ کاراکتر. |
postbackData | بار داده کدگذاری شده با base64 که عامل در یک رویداد کاربری، زمانی که کاربر روی پاسخ پیشنهادی ضربه میزند، دریافت میکند. |
اقدام پیشنهادی
وقتی ضربه زده شود، اقدام بومی مربوطه را در دستگاه آغاز میکند.
| نمایش JSON |
|---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
| فیلدها | |
|---|---|
text | متنی که در اقدام پیشنهادی نمایش داده میشود. حداکثر ۲۵ کاراکتر. |
postbackData | بار داده (با کدگذاری base64) که در رویداد کاربری که هنگام ضربه زدن کاربر روی اقدام پیشنهادی ایجاد میشود، به عامل ارسال میشود. حداکثر ۲۰۴۸ کاراکتر. |
fallbackUrl | (اختیاری) نشانی اینترنتی جایگزین برای استفاده در صورتی که کلاینت از اقدام پیشنهادی پشتیبانی نمیکند. نشانیهای اینترنتی جایگزین در پنجرههای مرورگر جدید باز میشوند. باید یک URI معتبر مطابق تعریف RFC 3986 باشد. حداکثر 2048 کاراکتر. |
action میدانی اتحادیه. اقدام بومی که هنگام ضربه زدن کاربر روی اقدام پیشنهادی در دستگاه آغاز میشود. action میتواند فقط یکی از موارد زیر باشد: | |
dialAction | برنامه شمارهگیر پیشفرض کاربر را با شماره تلفن مشخصشده توسط اپراتور که پر شده است، باز میکند. |
viewLocationAction | برنامه نقشه پیشفرض کاربر را باز میکند و مکان مشخصشده توسط عامل را انتخاب میکند یا با توجه به عبارت جستجوی مشخصشده توسط عامل، در اطراف مکان کاربر جستجو میکند. |
createCalendarEventAction | برنامه تقویم پیشفرض کاربر را باز میکند و جریان رویداد تقویم جدید را با دادههای رویداد مشخصشده توسط عامل که از قبل پر شدهاند، آغاز میکند. |
openUrlAction | برنامه مرورگر وب پیشفرض کاربر را به آدرس اینترنتی داده شده باز میکند. اگر کاربر برنامهای نصب کرده باشد که به عنوان کنترلکننده پیشفرض برای آدرس اینترنتی ثبت شده باشد، این برنامه به جای آن باز میشود و آیکون آن در رابط کاربری اقدام پیشنهادی استفاده خواهد شد. |
shareLocationAction | انتخابگر مکان برنامه RCS را باز میکند تا کاربر بتواند مکانی را برای ارسال به عامل انتخاب کند. |
دایل اکشن
برنامه شمارهگیر پیشفرض کاربر را با شماره تلفن مشخصشده توسط اپراتور که پر شده است، باز میکند.
| نمایش JSON |
|---|
{ "phoneNumber": string } |
| فیلدها | |
|---|---|
phoneNumber | شماره تلفن با فرمت E.164، برای مثال، +12223334444. |
مشاهده موقعیت مکانی اقدام
برنامه نقشه پیشفرض کاربر را باز میکند و مکان مشخصشده توسط عامل را انتخاب میکند یا با توجه به عبارت جستجوی مشخصشده توسط عامل، در اطراف مکان کاربر جستجو میکند.
| نمایش JSON |
|---|
{
"latLong": {
object ( |
| فیلدها | |
|---|---|
latLong | (اختیاری) طول و عرض جغرافیایی مکان مشخص شده. |
label | (اختیاری) برچسب پین در latLong افتاده است. |
query | (اختیاری، فقط در کلاینتهای پیامرسان اندروید پشتیبانی میشود) به جای مشخص کردن یک latLong (و به صورت اختیاری، یک برچسب)، عامل میتواند یک رشته پرسوجو (query string) مشخص کند. برای برنامههای نقشه پیشفرض که از قابلیت جستجو پشتیبانی میکنند (از جمله نقشههای گوگل)، ضربه زدن روی این اقدام پیشنهادی منجر به جستجوی مکانی با محوریت مکان فعلی کاربر میشود. اگر پرسوجو به اندازه کافی خاص باشد، عاملها میتوانند از آن برای انتخاب هر مکانی در جهان استفاده کنند. برای مثال، تنظیم رشته جستجو روی «بانک درخت در حال رشد» تمام مکانهای بانک درخت در حال رشد را در مجاورت کاربر نشان میدهد. تنظیم رشته جستجو روی «1600 Amphitheater Parkway, Mountain View, CA 94043» صرف نظر از موقعیت مکانی کاربر، آن آدرس خاص را انتخاب میکند. |
لاتلنگ
شیءای که یک جفت عرض/طول جغرافیایی را نشان میدهد. این به صورت یک جفت دوتایی بیان میشود تا درجه عرض جغرافیایی و درجه طول جغرافیایی را نشان دهد. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال باشند.
| نمایش JSON |
|---|
{ "latitude": number, "longitude": number } |
| فیلدها | |
|---|---|
latitude | عرض جغرافیایی بر حسب درجه. باید در محدوده [-90.0، +90.0] باشد. |
longitude | طول جغرافیایی بر حسب درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد. |
ایجاد رویداد تقویم (CreateCalendarEventAction)
برنامه تقویم پیشفرض کاربر را باز میکند و جریان رویداد تقویم جدید را با دادههای رویداد مشخصشده توسط عامل که از قبل پر شدهاند، آغاز میکند.
| نمایش JSON |
|---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
| فیلدها | |
|---|---|
startTime | زمان شروع رویداد. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
endTime | زمان پایان رویداد. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
title | عنوان رویداد. حداکثر ۱۰۰ کاراکتر. |
description | شرح رویداد. حداکثر ۵۰۰ کاراکتر. |
OpenUrlAction
برنامه مرورگر وب پیشفرض کاربر را به آدرس اینترنتی مشخصشده باز میکند. اگر کاربر برنامهای نصب کرده باشد که به عنوان کنترلکننده پیشفرض برای آدرس اینترنتی ثبت شده باشد، این برنامه به جای آن باز میشود و آیکون آن در رابط کاربری اقدام پیشنهادی استفاده خواهد شد.
| نمایش JSON |
|---|
{ "url": string, "application": enum ( |
| فیلدها | |
|---|---|
url | آدرس اینترنتی (URL) برای باز کردن. از اول نوامبر ۲۰۲۵، طرح URL باید https:// یا http:// باشد. درخواستهای API که از طرحهای دیگری (مثلاً tel:، mailto:، sms:) استفاده میکنند، پس از این تاریخ با خطای ۴۰۰ Bad Request رد خواهند شد. URL باید یک URI معتبر مطابق تعریف RFC 3986 باشد. حداکثر ۲۰۴۸ کاراکتر. |
application | با استفاده از URL، برنامه، مرورگر یا وبویو را باز کنید. برای بررسی اینکه آیا دستگاه کاربر از حالت وبویو پشتیبانی میکند یا خیر، ابتدا بررسی قابلیت را اجرا کنید. برای جزئیات بیشتر به مستندات مراجعه کنید: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities . |
webviewViewMode | حالت نمایش برای وب ویو. |
description | شرح دسترسی برای نمای وب. |
برنامه OpenUrl
نوع برنامه باز شده URL
| انومها | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED | مشخص نشده است، از مرورگر برای باز کردن استفاده خواهد شد. |
BROWSER | برای باز کردن آدرس اینترنتی از مرورگر استفاده کنید. |
WEBVIEW | باز کردن URL در یک پنجره نمایش وب یکپارچه |
نمای وب
نوع حالت نمایش وبویو.
| انومها | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED | مشخص نشده است. برای استفاده از وب ویو، باید حالت نمایش مشخص شود. |
FULL | به یک پوشش تمام صفحه با برچسب مکالمه Chatbot در نوار وضعیت نیاز دارد. |
HALF | به یک لایه پوششی نیم صفحه نیاز دارد. |
TALL | به یک پوشش سه چهارم صفحه نمایش نیاز دارد. |
کارت مستقل
کارت مستقل
| نمایش JSON |
|---|
{ "cardOrientation": enum ( |
| فیلدها | |
|---|---|
cardOrientation | جهت گیری کارت. |
thumbnailImageAlignment | ترازبندی پیشنمایش تصویر برای کارتهای مستقل با طرحبندی افقی. |
cardContent | محتوای کارت. |
جهتگیری مستقل کارت
جهت گیری کارت.
| انومها | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED | مشخص نشده است. |
HORIZONTAL | طرح بندی افقی. اگر |
VERTICAL | طرح عمودی. |
ترازبندی تصویر بندانگشتی مستقل
ترازبندی پیشنمایش تصویر برای کارتهای مستقل با طرحبندی افقی.
| انومها | |
|---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED | مشخص نشده است. |
LEFT | پیشنمایش فایل در سمت چپ تراز شده است. |
RIGHT | پیشنمایش فایل در سمت راست تراز شده است. |
نوع ترافیک پیام
انواع ترافیک پیام پشتیبانی شده. enum برای پشتیبانی از انواع ترافیک اضافی گسترش خواهد یافت.
| انومها | |
|---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED | رفتار پیشفرض: نوع ترافیک پیام توسط مورد استفادهی عامل تعیین میشود. نوع ترافیک را در صورت نیاز بر اساس محتوای پیام بهروزرسانی کنید. برای عاملهای چندمنظوره، هیچ پیشفرضی ارائه نشده است. نوع ترافیک باید به صورت دستی تنظیم شود (مثلاً تراکنش، ارتقاء). |
AUTHENTICATION | برای پیامهای احراز هویت در مورد استفاده از عامل OTP. |
TRANSACTION | برای پیامهای تراکنشی در موارد استفاده از عامل تراکنشی یا چندمنظوره. |
PROMOTION | برای پیامهای تبلیغاتی در موارد استفاده از عامل تبلیغاتی یا چند منظوره. |
SERVICEREQUEST | برای پیامهایی درباره خدماتی که کاربر به دریافت آنها رضایت داده است. مورد استفاده در موارد استفاده OTP، تراکنشی، تبلیغاتی یا عامل چندمنظوره. |
ACKNOWLEDGEMENT | برای پیامهایی که درخواست لغو اشتراک کاربر را تأیید میکنند. در موارد استفاده OTP، تراکنشی، تبلیغاتی یا عامل چندمنظوره استفاده میشود. |
روشها | |
|---|---|
| پیامی را از طرف نماینده به کاربر ارسال میکند. |
| پیام اپراتوری که ارسال شده اما هنوز تحویل داده نشده است را لغو میکند. |