REST Resource: phones.agentMessages

منبع: AgentMessage

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

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

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
فیلدها
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)

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

string

فقط برونداد. اطلاعات شرکت مخابراتی که شماره تلفن کاربر به آن تعلق دارد، طبق زیرینه‌های Google RCS. درحال‌حاضر، این فیلد فقط برای شماره تلفن‌های ایالات متحده تکمیل می‌شود.

فیلد اتحادیه expiration.

‫expiration فقط می‌تواند یکی از موارد زیر باشد:
expireTime

string (Timestamp format)

اختیاری. مُهر زمان به زمان UTC که این منبع منقضی درنظر گرفته می‌شود. اگر این مقدار تنظیم شده باشد یا اگر فیلد 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)

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

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

AgentContentMessage

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

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

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
فیلدها
suggestions[]

object (Suggestion)

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

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

دو نوع الگوی پیشنهاد وجود دارد: ماندگار و گذرا. برای جزئیات بیشتر، پیشنهادها را ببینید.
فیلد اتحادیه content. محتوای پیام کارگزار content فقط می‌تواند یکی از موارد زیر باشد:
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 
{

  // Union field card can be only one of the following:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
فیلدها
فیلد اتحادیه card. کارت مستقل یا گردونه کارت‌ها. ‫card فقط می‌تواند یکی از موارد زیر باشد:
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 ۱۲۰ درهم
MEDIUM ‫۲۳۲ نقطه.

CardContent

محتوای کارت

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

string

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

string

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

object (Media)

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

object (Suggestion)

(اختیاری) فهرست پیشنهادهایی که در کارت قرار می‌گیرد. حداکثر ۴ پیشنهاد.

رسانه

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

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

  // Union field content can be only one of the following:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
فیلدها
height

enum (Media.Height)

ارتفاع رسانه در کارت غنی با چیدمان عمودی. برای کارت مستقل با چیدمان افقی، ارتفاع قابل‌سفارشی‌سازی نیست و این فیلد نادیده گرفته می‌شود.
فیلد اتحادیه content. محتوای رسانه‌ای content فقط می‌تواند یکی از موارد زیر باشد:
fileName
(deprecated)

string

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

object (UploadedRbmFile)

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

object (ContentInfo)

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

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

ContentInfo

پیامی که حاوی اطلاعات محتوا است.

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

string

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

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

string

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

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

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

boolean

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

Media.Height

ارتفاع رسانه

شمارشی‌ها
HEIGHT_UNSPECIFIED نامشخص.
SHORT ۱۱۲ دلار
MEDIUM ۱۶۸ درهم
TALL ۲۶۴ نقطه

پیشنهاد

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

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

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
فیلدها
suggestionDisplay

enum (Suggestion.SuggestionDisplay)

اختیاری. رفتار نمایش پیشنهاد را کنترل می‌کند. فقط برای پیام‌های نوشتاری ساده‌ای که به مشتریان «پیام‌نگار Google» (نسخه 20260225.00 یا جدیدتر) ارسال می‌شود قابل‌اعمال است. این فیلد فقط باید روی پیشنهادهای مستقل مرتبط با پیام‌های نوشتاری ساده تنظیم شود. اگر این فیلد برای پیشنهادهای کارت‌های غنی یا پیشنهادهای مستقل با انتقال فایل اعمال شود، سرور پیام را رد می‌کند. این تنظیم فقط برای «پیام‌نگار Google» سریال‌سازی می‌شود؛ توسط مشتریان دیگر (مثل iOS یا Samsung) نادیده گرفته می‌شود.
فیلد اتحادیه option. پاسخ پیشنهادی یا کنش پیشنهادی. ‫option فقط می‌تواند یکی از موارد زیر باشد:
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,

  // Union field action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of list of possible types for union field action.
}
فیلدها
text

string

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

string

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

string

(اختیاری) نشانی وب جایگزین برای استفاده درصورتی‌که کارخواه از کنش پیشنهادی پشتیبانی نکند. نشانی‌های وب جایگزین در پنجره‌های مرورگر جدید باز می‌شوند. باید «نشانی وب» معتبری باشد که در RFC 3986 تعریف شده است. حداکثر ۲۰۴۸ نویسه.
فیلد اتحادیه action. کنش بومی که وقتی کاربر روی کنش پیشنهادی ضربه می‌زند در دستگاه آغاز می‌شود. ‫action فقط می‌تواند یکی از موارد زیر باشد:
dialAction

object (DialAction)

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

object (ViewLocationAction)

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

object (CreateCalendarEventAction)

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

object (OpenUrlAction)

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

object (ShareLocationAction)

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

DialAction

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

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

string

شماره تلفن در قالب E.164، برای مثال، ‎+12223334444.

ViewLocationAction

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

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

object (LatLng)

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

string

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

string

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

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

LatLng

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

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

number

عرض جغرافیایی به درجه. باید در محدوده [-۹۰.۰، +۹۰.۰] باشد.
longitude

number

طول جغرافیایی به درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد.

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)

نشانی وب برنامه، مرورگر، یا وب‌نمای باز. برای بررسی اینکه آیا دستگاه کاربر از حالت نمای وب پشتیبانی می‌کند، ابتدا بررسی قابلیت انجام دهید. برای جزئیات بیشتر، مستندات را ببینید: 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

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

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

RichMessageClassification

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

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

enum (RichMessageClassificationType)
segmentCount

integer

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

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

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

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

RichMessageClassificationType

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

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

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

روش‌ها

create

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

delete

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