REST Resource: phones.agentMessages

منبع: AgentMessage

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

نمایندگی JSON
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // 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

این فیلد توسط پلتفرم RBM تنظیم شده است. هنگام ایجاد پیام عامل، آن را درج نکنید. فیلد "phones/{E.164}/agentMessages/{messageId}" را حل می کند، که در آن {E.164} شماره تلفن کاربر در قالب E.164 است و {messageId} شناسه اختصاص داده شده توسط نماینده پیام نماینده است.

send Time

string ( Timestamp format)

این فیلد توسط پلتفرم RBM تنظیم شده است. هنگام ایجاد پیام عامل، آن را درج نکنید. فیلد زمان ارسال پیام به کاربر را تعیین می کند.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

content Message

object ( AgentContentMessage )

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

expiration میدان اتحادیه

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

expire Time

string ( Timestamp format)

اختیاری. مهر زمانی در UTC از زمانی که این منبع منقضی شده در نظر گرفته می شود. اگر فیلد TTL تنظیم شده باشد، این مقدار در خروجی ارائه می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

ttl

string ( Duration format)

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

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

AgentContent Message

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

نمایندگی 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 )

فهرستی از پاسخ‌های پیشنهادی و اقدامات پیشنهادی که به‌عنوان فهرستی از تراشه‌های پیشنهادی پس از پیام عامل مرتبط ظاهر می‌شوند. حداکثر 11 پیشنهاد

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

content زمینه اتحادیه محتوای content پیام نماینده فقط می تواند یکی از موارد زیر باشد:
text

string

متن کدگذاری شده در UTF-8. حداکثر 3072 کاراکتر.

fileName
(deprecated)

string

نام منحصر به فرد یک فایل پلت فرم RBM زمانی که یک عامل فایلی را آپلود می کند، نام فایل را برمی گرداند. به نفع uploadedRbmFile زیر منسوخ شد

uploaded Rbm File

object ( UploadedRbmFile )

حاوی شناسه‌هایی برای فایل و تصویر کوچکی است که در سرور RBM آپلود شده و توسط آن ارائه شده است.

rich Card

object ( RichCard )

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

content Info

object ( ContentInfo )

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

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

RbmFile آپلود شد

پیام حاوی اطلاعات فایل و تصویر کوچک

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

string

نام فایل که توسط پلتفرم RBM هنگام آپلود فایل برگردانده شده است.

thumbnail Name

string

نام تصویر کوچک، توسط پلتفرم RBM هنگام آپلود تصویر کوچک برگردانده شده است.

ریچ کارت

یک کارت غنی مستقل یا چرخ فلک کارت های غنی که از نماینده برای کاربر ارسال می شود.

نمایندگی 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 فقط می تواند یکی از موارد زیر باشد:
carousel Card

object ( CarouselCard )

چرخ فلک کارت.

standalone Card

object ( StandaloneCard )

کارت مستقل

CarouselCard

چرخ فلک کارت.

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

enum ( CarouselCard.CardWidth )

عرض کارت ها در چرخ فلک.

card Contents[]

object ( CardContent )

فهرست محتویات هر کارت در چرخ فلک. یک چرخ فلک می تواند حداقل 2 کارت و حداکثر 10 کارت داشته باشد.

CarouselCard.CardWidth

عرض کارت ها در چرخ فلک.

Enums
CARD_WIDTH_UNSPECIFIED مشخص نشده است.
SMALL 120 DP. توجه داشته باشید که نمی توان از رسانه های بلند استفاده کرد.
MEDIUM 232 DP.

محتوای کارت

محتوای کارت

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

string

(اختیاری) عنوان کارت. حداکثر 200 کاراکتر

description

string

(اختیاری) توضیحات کارت. حداکثر 2000 کاراکتر

media

object ( Media )

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

suggestions[]

object ( Suggestion )

(اختیاری) لیستی از پیشنهادات برای درج در کارت. حداکثر 10 پیشنهاد

رسانه ها

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

نمایندگی 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

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

uploaded Rbm File

object ( UploadedRbmFile )

حاوی شناسه‌هایی برای فایل و تصویر کوچکی است که در سرور RBM آپلود شده و توسط آن ارائه شده است.

content Info

object ( ContentInfo )

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

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

ContentInfo

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

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

string

URL فایل قابل دسترسی عمومی. هنگامی که پلتفرم فایل را واکشی می کند، پلتفرم RBM نوع MIME فایل را از قسمت نوع محتوا در هدرهای HTTP تعیین می کند. فیلد نوع محتوا باید در پاسخ HTTP از URL موجود و دقیق باشد. حداکثر اندازه فایل توصیه شده 100 مگابایت است.

thumbnail Url

string

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

اگر نشانی اینترنتی تصویر کوچک ارائه نکنید، پلتفرم RBM یک تصویر کوچک جای جای خالی را نمایش می دهد تا زمانی که دستگاه کاربر فایل را دانلود کند. بسته به تنظیمات کاربر، ممکن است فایل به طور خودکار دانلود نشود و ممکن است کاربر نیاز داشته باشد که روی دکمه دانلود ضربه بزند.

force Refresh

boolean

اگر تنظیم شود، پلتفرم RBM فایل و تصویر کوچک را از URL های مشخص شده واکشی می کند، حتی اگر پلتفرم کپی هایی از فایل (و/یا تصویر کوچک) را در حافظه پنهان ذخیره کرده باشد.

رسانه.قد

ارتفاع رسانه

Enums
HEIGHT_UNSPECIFIED مشخص نشده است.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. هنگامی که عرض کارت روی کوچک تنظیم شده باشد، برای چرخ فلک های کارت غنی موجود نیست.

پیشنهاد

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

نمایندگی JSON
{

  // 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.
}
فیلدها
option فیلد اتحادیه یک پاسخ پیشنهادی یا یک option اقدام پیشنهادی می تواند تنها یکی از موارد زیر باشد:
reply

object ( SuggestedReply )

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

action

object ( SuggestedAction )

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

پاسخ پیشنهادی

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

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

string

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

postback Data

string

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

اقدام پیشنهادی

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

نمایندگی 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)
  },
  "composeAction": {
    object (ComposeAction)
  }
  // End of list of possible types for union field action.
}
فیلدها
text

string

متنی که در عمل پیشنهادی نشان داده شده است. حداکثر 25 کاراکتر

postback Data

string

Payload (با کدگذاری پایه 64) که در رویداد کاربر که با ضربه زدن کاربر روی عملکرد پیشنهادی ایجاد می شود، برای عامل ارسال می شود. حداکثر 2048 کاراکتر.

fallback Url

string

(اختیاری) URL بازگشتی برای استفاده در صورت عدم پشتیبانی مشتری از یک اقدام پیشنهادی. URL های بازگشتی در پنجره های مرورگر جدید باز می شوند. باید یک URI معتبر همانطور که در RFC 3986 تعریف شده باشد. حداکثر 2048 نویسه.

action میدانی اتحادیه اقدام بومی که با ضربه زدن کاربر روی action پیشنهادی در دستگاه شروع می‌شود، می‌تواند تنها یکی از موارد زیر باشد:
dial Action

object ( DialAction )

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

view Location Action

object ( ViewLocationAction )

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

create Calendar Event Action

object ( CreateCalendarEventAction )

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

open Url Action

object ( OpenUrlAction )

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

share Location Action

object ( ShareLocationAction )

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

compose Action

object ( ComposeAction )

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

DialAction

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

نمایندگی JSON
{
  "phoneNumber": string
}
فیلدها
phone Number

string

شماره تلفن با فرمت E.164 به عنوان مثال +12223334444.

ViewLocationAction

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

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

object ( LatLng )

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

label

string

(اختیاری) برچسب پین در latLong افتاد.

query

string

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

به عنوان مثال، تنظیم رشته پرس و جو بر روی "Growing Tree Bank" تمام مکان های در حال رشد بانک درخت در مجاورت کاربر را نشان می دهد. تنظیم رشته پرس و جو روی "1600 Amphitheatre 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
}
فیلدها
start Time

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

end Time

string ( Timestamp format)

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

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

title

string

عنوان رویداد. حداکثر 100 کاراکتر

description

string

شرح رویداد. حداکثر 500 کاراکتر

OpenUrlAction

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

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

string

URL. باید یک URI معتبر همانطور که در RFC 3986 تعریف شده باشد. حداکثر 2048 نویسه.

application

enum ( OpenUrlApplication )

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

webview View Mode

enum ( WebviewViewMode )

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

description

string

توضیحات دسترسی برای مشاهده وب.

OpenUrlApplication

نوع برنامه باز URL

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

WebviewViewMode

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

Enums
WEBVIEW_VIEW_MODE_UNSPECIFIED مشخص نشده است. برای استفاده از webview باید یک حالت نمایش مشخص شود.
FULL به یک پوشش تمام صفحه با مکالمه Chatbot که در نوار وضعیت برچسب زده شده است نیاز دارد.
HALF نیاز به روکش نیم صفحه نمایش دارد.
TALL به یک پوشش سه چهارم صفحه نیاز دارد.

ShareLocationAction

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

انتخابگر مکان برنامه RCS را باز می کند تا کاربر بتواند مکانی را برای ارسال مجدد به نماینده انتخاب کند.

ComposeAction

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

نمایندگی JSON
{

  // Union field action can be only one of the following:
  "composeTextMessage": {
    object (ComposeAction.ComposeTextMessage)
  },
  "composeRecordingMessage": {
    object (ComposeAction.ComposeRecordingMessage)
  }
  // End of list of possible types for union field action.
}
فیلدها

action میدانی اتحادیه

action فقط می تواند یکی از موارد زیر باشد:

compose Text Message

object ( ComposeAction.ComposeTextMessage )

نوشتن و ارسال پیامک

compose Recording Message

object ( ComposeAction.ComposeRecordingMessage )

ضبط و ارسال پیام صوتی یا تصویری را آغاز کنید.

ComposeAction.ComposeTextMessage

نوشتن و ارسال پیامک

نمایندگی JSON
{
  "phoneNumber": string,
  "text": string
}
فیلدها
phone Number

string

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

text

string

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

ComposeAction.ComposeRecordingMessage

ضبط و ارسال پیام صوتی یا تصویری را آغاز کنید.

نمایندگی JSON
{
  "phoneNumber": string,
  "type": enum (ComposeRecordingActionType)
}
فیلدها
phone Number

string

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

type

enum ( ComposeRecordingActionType )

نوع عمل ضبط

ComposeRecordingActionType

نوع عمل ضبط نوشتن.

Enums
COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED مشخص نشده است.
ACTION_TYPE_AUDIO نوع صدا
ACTION_TYPE_VIDEO نوع ویدیو

کارت مستقل

کارت مستقل

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

enum ( StandaloneCard.CardOrientation )

جهت کارت.

thumbnail Image Alignment

enum ( StandaloneCard.ThumbnailImageAlignment )

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

card Content

object ( CardContent )

محتوای کارت

StandaloneCard.CardOrientation

جهت کارت.

Enums
CARD_ORIENTATION_UNSPECIFIED مشخص نشده است.
HORIZONTAL

طرح افقی.

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

VERTICAL طرح بندی عمودی

StandaloneCard.ThumbnailImageAlignment

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

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

روش ها

create

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

delete

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