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} شناسه اختصاص داده شده توسط نماینده پیام نماینده است.

sendTime

string ( Timestamp format)

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

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

contentMessage

object ( AgentContentMessage )

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

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

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

expireTime

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 پیشنهاد

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

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

string

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

fileName
(deprecated)

string

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

uploadedRbmFile

object ( UploadedRbmFile )

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

richCard

object ( RichCard )

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

contentInfo

object ( ContentInfo )

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

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

فایل Rbm آپلود شد

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

نمایندگی JSON
{
  "fileName": string,
  "thumbnailName": string
}
زمینه های
fileName

string

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

thumbnailName

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

object ( CarouselCard )

چرخ فلک کارت.

standaloneCard

object ( StandaloneCard )

کارت مستقل

CarouselCard

چرخ فلک کارت.

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

enum ( CarouselCard.CardWidth )

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

cardContents[]

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 )

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

رسانه ها

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

نمایندگی 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 زیر منسوخ شد

uploadedRbmFile

object ( UploadedRbmFile )

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

contentInfo

object ( ContentInfo )

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

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

ContentInfo

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

نمایندگی JSON
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
زمینه های
fileUrl

string

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

thumbnailUrl

string

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

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

forceRefresh

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 کاراکتر

postbackData

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)
  }
  // End of list of possible types for union field action.
}
زمینه های
text

string

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

postbackData

string

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

fallbackUrl

string

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

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

object ( DialAction )

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

viewLocationAction

object ( ViewLocationAction )

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

createCalendarEventAction

object ( CreateCalendarEventAction )

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

openUrlAction

object ( OpenUrlAction )

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

shareLocationAction

object ( ShareLocationAction )

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

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

(اختیاری، فقط در کلاینت‌های پیام‌های 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
}
زمینه های
startTime

string ( Timestamp format)

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

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

endTime

string ( Timestamp format)

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

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

title

string

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

description

string

شرح رویداد.

OpenUrlAction

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

نمایندگی JSON
{
  "url": string
}
زمینه های
url

string

URL

ShareLocationAction

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

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

کارت مستقل

کارت مستقل

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

جهت کارت.

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

طرح افقی.

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

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

StandaloneCard.ThumbnailImageAlignment

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

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

مواد و روش ها

create

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

delete

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