REST Resource: phones.agentMessages

منبع: AgentMessage

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

نمایش JSON
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },
  "messageTrafficType": enum (MessageTrafficType),
  "richMessageClassification": {
    object (RichMessageClassification)
  },
  "totalPayloadSizeBytes": string,
  "carrier": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "expireTime": string,
  "ttl": string
  // End of mutually exclusive fields.
}
فیلدها
name

string

این فیلد توسط پلاتفرم «سرویس‌های ارتباطی غنی ویژه کسب‌وکارها» تنظیم شده است. هنگام ایجاد پیام نماینده، آن را اضافه نکنید. این فیلد «phones/{E.164}/agentMessages/{messageId}» را حل می‌کند، که در آن {E.164} شماره تلفن کاربر در قالب E.164 و {messageId} شناسه اختصاص‌داده‌شده توسط نماینده برای پیام نماینده است.

sendTime

string (Timestamp format)

این فیلد توسط پلاتفرم «سرویس‌های ارتباطی غنی ویژه کسب‌وکارها» تنظیم شده است. هنگام ایجاد پیام نماینده، آن را اضافه نکنید. این فیلد زمان ارسال پیام به کاربر را مشخص می‌کند.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

contentMessage

object (AgentContentMessage)

محتوای پیام نماینده.

messageTrafficType

enum (MessageTrafficType)

نوع ترافیک پیام.

richMessageClassification

object (RichMessageClassification)

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

totalPayloadSizeBytes

string (int64 format)

فقط خروجی. اندازه کل پایه‌بار پیام به بایت. بار خالص همه پیوست‌ها را در پیام «RCS ویژه کسب‌وکارها» می‌شمارد که می‌تواند ویدیو، تصویر، PDF، و غیره باشد، به‌جز نوشتار پیام یا پیشنهادها. درحال‌حاضر، این فیلد فقط برای شماره تلفن‌های ایالات متحده پر می‌شود.

carrier

string

فقط خروجی. اطلاعات شرکت مخابراتی که شماره تلفن کاربر به آن تعلق دارد، طبق باطن‌های «سرویس‌های ارتباطی غنی» Google. درحال‌حاضر، این فیلد فقط برای شماره تلفن‌های ایالات متحده پر می‌شود.

در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
expireTime

string (Timestamp format)

اختیاری. مُهر زمان به ساعت هماهنگ جهانی (UTC) برای زمانی که این منبع منقضی‌شده درنظر گرفته می‌شود. باید حداقل شش ثانیه پس‌از ارسال پیام باشد. اگر مُهر زمان آینده کمتر از شش ثانیه پس‌از ارسال مشخص شود، پلاتفرم به‌طور خودکار آن را به شش ثانیه تنظیم می‌کند. هر مُهر زمانی که در زمان ارسال پیام یا قبل‌از آن باشد، خطای 400 INVALID_ARGUMENT را برمی‌گرداند. اگر expireTime یا ttl در درخواست تنظیم شده باشد، این مقدار در خروجی برگردانده می‌شود و هرگونه اصلاحات در مقدار را منعکس می‌کند.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

ttl

string (Duration format)

اختیاری. فقط ورودی. مدت زمانی که پیام قبل‌از لغو خودکار فعال خواهد بود. حداقل مقدار شش ثانیه است. اگر مدت‌زمان مثبتی کمتر از شش ثانیه مشخص شود، پلاتفرم به‌طور خودکار آن را به شش ثانیه تنظیم می‌کند و مقدار تنظیم‌شده را در فیلد expireTime پاسخ منعکس می‌کند. هر مدت غیرمثبتی (صفر یا کمتر) خطای 400 INVALID_ARGUMENT برمی‌گرداند.

مدت‌زمان به ثانیه با حداکثر نه رقم اعشاری، که به «s» ختم می‌شود. مثال: "3.5s".

پایان فیلدهای متقابلاً انحصاری.

AgentContentMessage

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

نمایش JSON
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of mutually exclusive fields.
}
فیلدها
suggestions[]

object (Suggestion)

فهرستی از پاسخ‌های پیشنهادی و کنش‌های پیشنهادی که به‌صورت فهرستی از تراشه‌های پیشنهادی به‌دنبال پیام نماینده مربوطه نشان داده می‌شود. حداکثر ۱۱ پیشنهاد.

تراشه‌ها فقط زمانی نمایش داده می‌شوند که پیام نماینده مرتبط جدیدترین پیام در مکالمه باشد (شامل پیام‌های نماینده و کاربر). کاربر می‌تواند روی پاسخ پیشنهادی تک‌ضرب بزند تا پاسخ نوشتاری را به نماینده ارسال کند یا روی کنش پیشنهادی تک‌ضرب بزند تا کنش بومی را در دستگاه شروع کند.

دو نوع الگوی پیشنهاد وجود دارد: پایدار و گذرا. برای جزئیات بیشتر، پیشنهادها را ببینید.

محتوای پیام نماینده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
text

string

نوشتار کدبندی‌شده در UTF-8. حداکثر ۳۰۷۲ نویسه.

fileName
(deprecated)

string

نام یکتای فایل. وقتی عاملی فایلی را بارگذاری می‌کند، پلاتفرم ‹RCS ویژه «کسب‌وکارها»› نام فایل را برمی‌گرداند. منسوخ‌شده به‌نفع uploadedRbmFile در زیر.

uploadedRbmFile

object (UploadedRbmFile)

حاوی شناسه‌هایی برای فایل و ریزعکس است که در سرور «RCS ویژه کسب‌وکارها» بارگذاری شده‌اند و ازطریق آن ارائه می‌شوند.

richCard

object (RichCard)

کارت غنی مستقل.

contentInfo

object (ContentInfo)

اطلاعات مربوط به فایل، ازجمله نشانی وب فایل و نشانی وب ریزعکس فایل.

پلاتفرم ‹RCS ویژه «کسب‌وکارها»› محتوا را از حافظه نهان ارائه می‌دهد، اما عامل می‌تواند پلاتفرم ‹RCS ویژه «کسب‌وکارها»› را مجبور کند نسخه جدیدی از محتوا را واکشی کند و حافظه نهان را بازآوری کند.

پایان فیلدهای متقابلاً انحصاری.

UploadedRbmFile

پیام حاوی اطلاعات فایل و ریزعکس

نمایش JSON
{
  "fileName": string,
  "thumbnailName": string
}
فیلدها
fileName

string

نام فایل که هنگام بارگذاری فایل توسط پلاتفرم ‹RCS ویژه «کسب‌وکارها»› برگردانده شده است.

thumbnailName

string

نام ریزعکس که هنگام بارگذاری ریزعکس توسط پلاتفرم ‹RCS ویژه «کسب‌وکارها»› برگردانده شده است.

RichCard

کارت غنی مستقل یا گردونه‌ای از کارت‌های غنی که از نماینده به کاربر ارسال شده است.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of mutually exclusive fields.
}
فیلدها
کارت مستقل یا گردونه کارت‌ها. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
carouselCard

object (CarouselCard)

گردونه کارت‌ها.

standaloneCard

object (StandaloneCard)

کارت مستقل.

پایان فیلدهای متقابلاً انحصاری.

CarouselCard

گردونه کارت‌ها.

نمایش JSON
{
  "cardWidth": enum (CarouselCard.CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
فیلدها
cardWidth

enum (CarouselCard.CardWidth)

عرض کارت‌ها در گردونه.

cardContents[]

object (CardContent)

فهرست محتوا برای هر کارت در گردونه. گردونه می‌تواند حداقل ۲ کارت و حداکثر ۱۰ کارت داشته باشد.

CarouselCard.CardWidth

عرض کارت‌ها در گردونه.

شمارشی‌ها
CARD_WIDTH_UNSPECIFIED مشخص نشده است.
SMALL ‫۱۲۰ DP.
MEDIUM ‫۲۳۲ DP.

CardContent

محتوای کارت

نمایش JSON
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
فیلدها
title

string

(اختیاری) عنوان کارت. حداکثر ۲۰۰ نویسه.

description

string

(اختیاری) شرح کارت. حداکثر ۲۰۰۰ نویسه.

media

object (Media)

(اختیاری) رسانه (تصویر، GIF، ویدیو، PDF) برای گنجاندن در کارت.

suggestions[]

object (Suggestion)

(اختیاری) فهرست پیشنهادهایی که باید در کارت گنجانده شود. حداکثر ۴ پیشنهاد.

رسانه

فایل رسانه‌ای در کارت غنی.

نمایش JSON
{
  "height": enum (Media.Height),
  "contentDescription": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of mutually exclusive fields.
}
فیلدها
height

enum (Media.Height)

ارتفاع رسانه در کارت غنی با چیدمان عمودی. برای کارت مستقل با چیدمان افقی، به‌جای HEIGHT_UNSPECIFIED از TALL استفاده کنید تا با iOS سازگار باشد.

contentDescription

string

اختیاری. محتوای رسانه را برای دسترس‌پذیری شرح می‌دهد و نوشتار جایگزین ارائه می‌کند. تا ۲۰۰ نویسه نوشتار ساده را پشتیبانی می‌کند.

محتوای رسانه موارد زیر فهرستی از فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
fileName
(deprecated)

string

نام یکتای فایل که هنگام بارگذاری فایل توسط پلاتفرم ‹RCS ویژه «کسب‌وکارها»› برگردانده شده است. منسوخ‌شده به‌نفع uploadedRbmFile در زیر.

uploadedRbmFile

object (UploadedRbmFile)

حاوی شناسه‌هایی برای فایل و ریزعکس است که در سرور «RCS ویژه کسب‌وکارها» بارگذاری شده‌اند و ازطریق آن ارائه می‌شوند.

contentInfo

object (ContentInfo)

اطلاعات مربوط به فایل، ازجمله نشانی وب فایل و نشانی وب ریزعکس فایل.

پلاتفرم ‹RCS ویژه «کسب‌وکارها»› محتوا را از حافظه نهان ارائه می‌دهد، اما عامل می‌تواند پلاتفرم ‹RCS ویژه «کسب‌وکارها»› را مجبور کند نسخه جدیدی از محتوا را واکشی کند و حافظه نهان را بازآوری کند.

پایان فیلدهای متقابلاً انحصاری.

ContentInfo

پیام حاوی اطلاعات محتوا.

نمایش JSON
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
فیلدها
fileUrl

string

نشانی وب فایل که برای عموم قابل‌دسترسی باشد. پلاتفرم «RCS ویژه کسب‌وکارها» نوع MIME فایل را از فیلد نوع محتوا در سرایندهای HTTP هنگام واکشی فایل توسط پلاتفرم تعیین می‌کند. فیلد content-type باید در پاسخ HTTP از نشانی وب وجود داشته باشد و دقیق باشد. حداکثر اندازه فایل توصیه‌شده ۱۰۰ مگابایت است.

توجه: تغییر مسیر در نشانی‌های وب فایل پشتیبانی نمی‌شود. اگر تغییر مسیر لازم است، لطفاً از CreateFileRequest استفاده کنید.

thumbnailUrl

string

(اختیاری، فقط برای فایل‌های تصویری، صوتی، و ویدیویی) نشانی وب تصویر کوچک که برای عموم قابل‌دسترس باشد. حداکثر اندازه ۱۰۰ کیلوبایت.

اگر نشانی وب ریزعکس را ارائه نکنید، پلاتفرم «RCS ویژه کسب‌وکارها» تا زمانی‌که دستگاه کاربر فایل را بارگیری کند، ریزعکس جای‌بان خالی را نمایش می‌دهد. بسته به تنظیمات کاربر، ممکن است فایل به‌طور خودکار بارگیری نشود و لازم باشد کاربر روی دکمه بارگیری ضربه بزند.

توجه: تغییر مسیر در نشانی‌های وب فایل پشتیبانی نمی‌شود. اگر تغییر مسیر لازم است، لطفاً از CreateFileRequest استفاده کنید.

forceRefresh

boolean

اگر تنظیم شود، پلاتفرم «RCS ویژه کسب‌وکارها» فایل و ریزعکس را از نشانی‌های وب مشخص‌شده واکشی می‌کند، حتی اگر پلاتفرم نسخه‌های ذخیره‌شده در حافظه نهان فایل (و/یا ریزعکس) را داشته باشد.

Media.Height

ارتفاع رسانه

شمارشی‌ها
HEIGHT_UNSPECIFIED مشخص نشده است.
SHORT ‫۱۱۲ پیکسل مستقل از تراکم.
MEDIUM ‫۱۶۸ پیکسل مستقل از تراکم.
TALL ‫۲۶۴ DP.

پیشنهاد

پاسخ پیشنهادی یا کنش پیشنهادی که در کارت غنی یا در فهرست تراشه پیشنهاد گنجانده شده است.

نمایش JSON
{
  "suggestionDisplay": enum (Suggestion.SuggestionDisplay),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of mutually exclusive fields.
}
فیلدها
suggestionDisplay

enum (Suggestion.SuggestionDisplay)

اختیاری. رفتار نمایش پیشنهاد را کنترل می‌کند. فقط برای پیام‌های نوشتاری ساده که به کارخواه‌های «پیام‌نگار Google» (نسخه ۲۰۲۶۰۲۲۵.۰۰ یا جدیدتر) ارسال می‌شوند قابل‌اجرا است. این فیلد فقط باید در پیشنهادهای مستقل مرتبط با پیام‌های نوشتار ساده تنظیم شود. اگر این فیلد برای پیشنهادها در کارت‌های غنی یا پیشنهادهای مستقل با انتقال فایل اعمال شود، سرور پیام را رد خواهد کرد. این تنظیم فقط برای «پیام‌نگار Google» سریال‌سازی شده است؛ دیگر کارخواه‌ها (مثل iOS یا Samsung) آن را نادیده می‌گیرند.

پاسخ پیشنهادی یا کنش پیشنهادی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
reply

object (SuggestedReply)

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

action

object (SuggestedAction)

کاربران می‌توانند روی کنش پیشنهادی ضربه بزنند تا کنش بومی مربوطه را در دستگاه شروع کنند.

پایان فیلدهای متقابلاً انحصاری.

SuggestedReply

وقتی روی آن تک‌ضرب زده شود، پاسخ نوشتاری را به نماینده برمی‌گرداند.

نمایش JSON
{
  "text": string,
  "postbackData": string
}
فیلدها
text

string

نوشتاری که در پاسخ پیشنهادی نشان داده می‌شود و وقتی کاربر روی آن تک‌ضرب می‌زند به نماینده ارسال می‌شود. حداکثر ۲۵ نویسه.

postbackData

string

بار داده کدگذاری‌شده با base64 که وقتی کاربر روی پاسخ پیشنهادی تک‌ضرب می‌زند، نماینده در رویداد کاربر دریافت می‌کند.

SuggestedAction

وقتی روی آن تک‌ضرب زده شود، کنش بومی مربوطه را در دستگاه آغاز می‌کند.

نمایش JSON
{
  "text": string,
  "postbackData": string,
  "fallbackUrl": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of mutually exclusive fields.
}
فیلدها
text

string

نوشتاری که در کنش پیشنهادی نشان داده می‌شود. حداکثر ۲۵ نویسه.

postbackData

string

بار داده (کدگذاری‌شده با base64) که در رویداد کاربر که درنتیجه ضربه زدن کاربر روی کنش پیشنهادی ایجاد می‌شود به نماینده ارسال خواهد شد. حداکثر ۲۰۴۸ نویسه.

fallbackUrl

string

(اختیاری) نشانی وب جایگزین برای استفاده درصورتی‌که کلاینت از کنش پیشنهادی پشتیبانی نکند. نشانی‌های وب بازگشتی در پنجره‌های جدید مرورگر باز می‌شوند. باید شناسه منبع یکسان معتبری باشد که در RFC 3986 تعریف شده است. حداکثر ۲۰۴۸ نویسه.

کنش بومی که وقتی کاربر روی کنش پیشنهادی ضربه می‌زند در دستگاه شروع می‌شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
dialAction

object (DialAction)

برنامه شماره‌گیر پیش‌فرض کاربر را باز می‌کند و شماره تلفن مشخص‌شده توسط نماینده را در آن وارد می‌کند.

viewLocationAction

object (ViewLocationAction)

برنامه نقشه پیش‌فرض کاربر را باز می‌کند و مکان مشخص‌شده توسط نماینده را انتخاب می‌کند یا بااستفاده از پُرسمان مشخص‌شده توسط نماینده، اطراف مکان کاربر را جستجو می‌کند.

createCalendarEventAction

object (CreateCalendarEventAction)

برنامه تقویم پیش‌فرض کاربر را باز می‌کند و جریان رویداد تقویم جدید را با داده‌های رویداد مشخص‌شده توسط نماینده که ازقبل تکمیل شده است شروع می‌کند.

openUrlAction

object (OpenUrlAction)

برنامه مرورگر وب پیش‌فرض کاربر را در نشانی وب ارائه‌شده باز می‌کند. اگر کاربر برنامه‌ای نصب کرده باشد که به‌عنوان کنترل‌کننده پیش‌فرض برای نشانی وب ثبت شده باشد، این برنامه به‌جای آن باز می‌شود و از نماد آن در میانای کاربری کنش پیشنهادی استفاده می‌شود.

shareLocationAction

object (ShareLocationAction)

انتخاب‌گر مکان برنامه «سرویس‌های ارتباطی غنی» را باز می‌کند تا کاربر بتواند مکانی را برای ارسال به نماینده انتخاب کند.

پایان فیلدهای متقابلاً انحصاری.

DialAction

برنامه شماره‌گیر پیش‌فرض کاربر را باز می‌کند و شماره تلفن مشخص‌شده توسط نماینده را در آن وارد می‌کند.

نمایش JSON
{
  "phoneNumber": string
}
فیلدها
phoneNumber

string

شماره تلفن در قالب E.164، برای مثال، ‎+۱-۲۲۲-۳۳۳-۴۴۴۴.

ViewLocationAction

برنامه نقشه پیش‌فرض کاربر را باز می‌کند و مکان مشخص‌شده توسط نماینده را انتخاب می‌کند یا بااستفاده از پُرسمان مشخص‌شده توسط نماینده، اطراف مکان کاربر را جستجو می‌کند.

نمایش JSON
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
فیلدها
latLong

object (LatLng)

(اختیاری) طول و عرض جغرافیایی مکان مشخص‌شده.

label

string

(اختیاری) برچسب سنجاق رهاشده در latLong.

query

string

(اختیاری) به‌جای مشخص کردن latLong (و به‌صورت اختیاری، برچسب)، نماینده می‌تواند رشته پُرسمان را مشخص کند. برای برنامه‌های نقشه پیش‌فرض که از عملکرد جستجو پشتیبانی می‌کنند (ازجمله Google Maps)، تک‌ضرب زدن روی این کنش پیشنهادی منجر به جستجوی مکان با محوریت مکان فعلی کاربر می‌شود. اگر پُرسمان به‌اندازه کافی خاص باشد، نمایندگان می‌توانند از آن برای انتخاب هر مکانی در جهان استفاده کنند.

برای مثال، تنظیم رشته پُرسمان روی «Growing Tree Bank» همه مکان‌های Growing Tree Bank را در مجاورت کاربر نشان می‌دهد. تنظیم رشته پُرسمان روی «1600 Amphitheater Parkway, Mountain View, CA 94043» آن نشانی خاص را بدون درنظر گرفتن مکان کاربر انتخاب می‌کند.

LatLng

شیئی که نشان‌دهنده جفت طول/عرض جغرافیایی است. این مقدار به‌صورت جفت عدد اعشاری با دقت مضاعف بیان می‌شود تا درجه عرض جغرافیایی و درجه طول جغرافیایی را نشان دهد. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده‌های نرمال‌شده باشد.

نمایش JSON
{
  "latitude": number,
  "longitude": number
}
فیلدها
latitude

number

عرض جغرافیایی به درجه. باید در محدوده [-90.0, +90.0] باشد.

longitude

number

طول جغرافیایی به درجه. باید در محدوده [-180.0, +180.0] باشد.

CreateCalendarEventAction

برنامه تقویم پیش‌فرض کاربر را باز می‌کند و جریان رویداد تقویم جدید را با داده‌های رویداد مشخص‌شده توسط نماینده که ازقبل تکمیل شده است شروع می‌کند.

نمایش JSON
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
فیلدها
startTime

string (Timestamp format)

زمان شروع رویداد.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

زمان پایان رویداد.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

title

string

عنوان رویداد. حداکثر ۱۰۰ نویسه.

description

string

شرح رویداد. حداکثر ۵۰۰ نویسه.

OpenUrlAction

برنامه مرورگر وب پیش‌فرض کاربر را در نشانی وب مشخص‌شده باز می‌کند. اگر کاربر برنامه‌ای نصب کرده باشد که به‌عنوان کنترل‌کننده پیش‌فرض برای نشانی وب ثبت شده باشد، این برنامه به‌جای آن باز می‌شود و از نماد آن در میانای کاربری کنش پیشنهادی استفاده می‌شود.

نمایش JSON
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
فیلدها
url

string

نشانی وب برای باز کردن. از ۱ نوامبر ۲۰۲۵، طرح‌واره نشانی وب باید ‎https:// ‎ یا ‎http://‎ باشد. درخواست‌های API که از طرح‌های دیگر (مثلاً tel:،‏ mailto:،‏ sms:) استفاده می‌کنند، پس‌از این تاریخ با خطای «۴۰۰ درخواست نامعتبر» رد خواهند شد. نشانی وب باید شناسه منبع یکسان معتبری باشد که در RFC 3986 تعریف شده است. حداکثر ۲۰۴۸ نویسه.

application

enum (OpenUrlApplication)

نشانی وب برنامه، مرورگر، یا وب‌نمای باز. برای بررسی اینکه آیا دستگاه کاربر از حالت webview پشتیبانی می‌کند یا نه، ابتدا بررسی قابلیت را اجرا کنید. برای جزئیات، به اسناد مراجعه کنید: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.

webviewViewMode

enum (WebviewViewMode)

حالت مشاهده برای نمای وب.

description

string

شرح دسترس‌پذیری برای نمای وب.

OpenUrlApplication

نوع برنامه باز کردن نشانی وب

شمارشی‌ها
OPEN_URL_APPLICATION_UNSPECIFIED مشخص نشده است، برای باز کردن از مرورگر استفاده خواهد شد.
BROWSER از مرورگر برای باز کردن نشانی وب استفاده کنید.
WEBVIEW باز کردن نشانی وب در پنجره نمای وب یکپارچه

WebviewViewMode

نوع حالت نمای وب‌نمای.

شمارشی‌ها
WEBVIEW_VIEW_MODE_UNSPECIFIED مشخص نشده است. برای استفاده از وب‌نما، باید حالت نمایشی مشخص شود.
FULL به هم‌پوشانی تمام‌صفحه با مکالمه «ربات گپ» برچسب‌گذاری‌شده در نوار وضعیت نیاز دارد.
HALF به هم‌پوشانی نیم‌صفحه نیاز دارد.
TALL به هم‌پوشانی سه‌چهارم صفحه نیاز دارد.

ShareLocationAction

این نوع فیلدی ندارد.

انتخاب‌گر مکان برنامه «سرویس‌های ارتباطی غنی» را باز می‌کند تا کاربر بتواند مکانی را برای ارسال به نماینده انتخاب کند.

Suggestion.SuggestionDisplay

رفتار نمایشی پیشنهادهای نوشتاری مستقل.

شمارشی‌ها
SUGGESTION_DISPLAY_UNSPECIFIED

کارخواهان رفتار نمایش پیش‌فرض را اجرا می‌کنند:

  • «پیام‌نگار Google» برای پیام‌های نوشتاری ساده مستقل: پیشنهادها پس‌از ارسال یا دریافت پیام‌های جدید ناپدید می‌شوند.
  • iOS برای پیام‌های نوشتاری ساده مستقل: پیشنهادها فقط پس‌از اینکه کاربر روی آن‌ها تک‌ضرب می‌زند ناپدید می‌شوند.
  • همه کارخواه‌ها برای کارت‌های غنی: پیشنهادها همیشه پایدار هستند؛ تنظیم suggestionDisplay روی کارت‌های غنی منجر به خطای ۴۰۰ می‌شود.
PERSISTENT پیشنهاد به‌طور مداوم در حباب پیام قابل‌مشاهده است، حتی زمانی که پیام‌های جدیدی به مکالمه اضافه می‌شود.

StandaloneCard

کارت مستقل

نمایش JSON
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
فیلدها
cardOrientation

enum (StandaloneCard.CardOrientation)

جهت کارت.

thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

تراز پیش‌نمایش تصویر برای کارت‌های مستقل با چیدمان افقی.

cardContent

object (CardContent)

محتوای کارت.

StandaloneCard.CardOrientation

جهت کارت.

شمارشی‌ها
CARD_ORIENTATION_UNSPECIFIED مشخص نشده است.
HORIZONTAL

چیدمان افقی.

اگر object(CardContent) کارت غنی افقی حاوی فیلد media باشد، باید حداقل فیلد title، description، یا suggestions[] را نیز داشته باشد.

VERTICAL چیدمان عمودی.

StandaloneCard.ThumbnailImageAlignment

تراز پیش‌نمایش تصویر برای کارت‌های مستقل با چیدمان افقی.

شمارشی‌ها
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED مشخص نشده است.
LEFT پیش‌نمایش فایل چپ‌چین است.
RIGHT پیش‌نمایش فایل راست‌چین است.

MessageTrafficType

انواع ترافیک پیام پشتیبانی‌شده. این enum برای پشتیبانی از انواع ترافیک بیشتر گسترش خواهد یافت. توجه داشته باشید که اگرچه مورد استفاده عامل می‌تواند راهنمایی‌هایی برای نوع ترافیک مورد استفاده ارائه دهد، اما هیچ‌گونه اجرای API در رابطه با آن‌ها وجود ندارد.

شمارشی‌ها
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED رفتار پیش‌فرض: نوع ترافیک پیام براساس مورد استفاده نماینده تعیین می‌شود. نوع ترافیک را براساس محتوای پیام درصورت نیاز به‌روز کنید. برای عامل‌های چندمنظوره، هیچ پیش‌فرضی ارائه نمی‌شود. نوع ترافیک باید به‌صورت دستی تنظیم شود (مثلاً، TRANSACTION، PROMOTION).
AUTHENTICATION برای پیام‌های اصالت‌سنجی (برای مورد استفاده نماینده گذرواژه یک‌بارمصرف توصیه می‌شود).
TRANSACTION برای پیام‌های تراکنشی (برای موارد استفاده از نماینده «تراکنشی» یا «چندمنظوره» توصیه می‌شود).
PROMOTION برای پیام‌های تبلیغاتی (برای موارد استفاده از نماینده تبلیغاتی یا چندمنظوره توصیه می‌شود).
SERVICEREQUEST برای پیام‌های مربوط به سرویس‌هایی که کاربر با دریافت آن‌ها موافقت کرده است (برای موارد استفاده از نماینده «گذرواژه یک‌بارمصرف»، «تراکنشی»، «تبلیغاتی»، یا «چندمنظوره» توصیه می‌شود).
ACKNOWLEDGEMENT برای پیام‌هایی که درخواست «لغو اشتراک» کاربر را تأیید می‌کنند (برای موارد استفاده از نماینده «گذرواژه یک‌بارمصرف»، «تراکنشی»، «تبلیغاتی»، یا «چندمنظوره» توصیه می‌شود).

RichMessageClassification

فقط برای صدور صورت‌حساب در ایالات متحده: جزئیات مربوط به طبقه‌بندی‌های پیام مورداستفاده برای صدور صورت‌حساب.

نمایش JSON
{
  "classificationType": enum (RichMessageClassificationType),
  "segmentCount": integer
}
فیلدها
classificationType

enum (RichMessageClassificationType)

segmentCount

integer

تعداد بخش‌های ۱۶۰ بایتی برای نوشتار پیام، همیشه به بالا گرد می‌شود.

فقط ازطریق کل طول بایت UTF-8 محتوای نوشتاری محاسبه می‌شود؛ داده‌های پاسخ‌ها یا کنش‌های پیشنهادی مستثنی می‌شوند.

برای مثال، یک پیامک با طول ۳۰۰ بایت دارای segmentCount برابر با ۲ است.

این فیلد فقط برای انواع RICH_MESSAGE پر می‌شود.

RichMessageClassificationType

فقط برای صورت‌حساب ایالات متحده: طبقه‌بندی پیام را برای صورت‌حساب مشخص می‌کند.

مهم: شرکت‌های مخابراتی ایالات متحده قیمت انواع پیام‌های قابل‌صورت‌حساب را که در این صفحه شرح داده شده است تعیین می‌کنند. شرکت‌های مخابراتی ایالات متحده همچنین هزینه نهایی توسعه‌دهنده را برای ارسال پیام‌های «RCS ویژه کسب‌وکارها» تعیین می‌کنند. برای اطلاعات بیشتر درباره قیمت‌گذاری یا صورت‌حساب، لطفاً با نمایندگان شرکت مخابراتی مربوطه تماس بگیرید.

شمارشی‌ها
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED نامشخص
RICH_MESSAGE پیام تحت شرایط زیر به‌عنوان غنی طبقه‌بندی می‌شود: ۱. حاوی کارت‌های غنی نیست. ۲. حاوی فایل پیوست نباشد. ۳. هر کنش پیشنهادی که در آن وجود دارد باید کنش «شماره‌گیری» یا کنش «باز کردن نشانی وب» باشد که از وب‌نما استفاده نمی‌کند.
RICH_MEDIA_MESSAGE هر پیامی که معیارهای RICH_MESSAGE را برآورده نکند. این شامل پیام‌های حاوی کارت غنی، فایل رسانه‌ای، یا هر کنش پیشنهادی به‌جز «شماره‌گیری» یا «باز کردن نشانی وب در مرورگر» می‌شود.
SUGGESTED_ACTION_CLICK نشان‌دهنده ضربه زدن کاربر روی کنش پیشنهادی (نه پاسخ پیشنهادی) است. این طبقه‌بندی فقط برای کنش‌های کاربر اعمال می‌شود و منحصراً در بارداده UserMessage وب‌قلاب نشان داده می‌شود. این مورد برای پیام‌های «برنامه به شخص» اعمال نمی‌شود.

روش‌ها

create

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

delete

پیام نماینده‌ای را که ارسال شده اما هنوز تحویل داده نشده است لغو می‌کند.