REST Resource: conversations.messages

منبع: پیام

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

نمایندگی JSON
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
زمینه های
name

string

نام پیام، همانطور که توسط Business Messages تنظیم شده است. به "مکالمات/{conversationId}/messages/{messageId}"، که در آن {conversationId} شناسه منحصر به فرد مکالمه و {messageId} شناسه منحصر به فرد پیام است، حل می شود.

messageId

string

ضروری. شناسه منحصربفرد پیام که توسط عامل تعیین شده است. اگر پیامی بخواهد از همان messageId پیام قبلی استفاده کند، تحویل صحیح پیام ممکن است تحت تأثیر قرار گیرد.

representative

object ( Representative )

جزئیات مربوط به نماینده (انسان یا ربات چت) که پیام را ارسال کرده است.

suggestions[]

object ( Suggestion )

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

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

fallback

string

اختیاری. متن بازگشتی که اگر دستگاه کاربر از نوع پیام یا محتوای آن پشتیبانی نمی‌کند، نمایش داده می‌شود. حداکثر 3072 کاراکتر.

containsRichText

boolean

اختیاری. اگر true ، نشان می دهد که پیام حاوی متن غنی است. اگر پیام دارای قالب بندی نامعتبر باشد، Business Messages یک خطا برمی گرداند.

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

string

پیام متنی. حداکثر 3072 کاراکتر.

image

object ( Image )

پیام تصویری

richCard

object ( RichCard )

پیام کارت غنی.

تصویر

یک تصویر.

نمایندگی JSON
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
زمینه های
content زمینه اتحادیه محتوای تصویر. content فقط می تواند یکی از موارد زیر باشد:
contentInfo

object ( ContentInfo )

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

ContentInfo

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

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

string

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

حداکثر 5 مگابایت

انواع محتوای پشتیبانی شده: image/jpeg، image/jpg، image/png، image/webp

thumbnailUrl

string

اختیاری. URL تصویر کوچک قابل دسترسی عمومی.

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

حداکثر 25 کیلوبایت

انواع محتوای پشتیبانی شده: image/jpeg، image/jpg، image/png، image/webp

forceRefresh

boolean

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

altText

string

متنی که جزئیات رسانه را برای اهداف دسترسی توصیف می کند.

ریچ کارت

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

نمایندگی JSON
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
زمینه های
card میدان اتحادیه . انواع احتمالی کارت های غنی card فقط می تواند یکی از موارد زیر باشد:
standaloneCard

object ( StandaloneCard )

کارت مستقل

carouselCard

object ( CarouselCard )

چرخ فلک کارت.

کارت مستقل

کارت مستقل

نمایندگی JSON
{
  "cardContent": {
    object (CardContent)
  }
}
زمینه های
cardContent

object ( CardContent )

محتوای کارت

محتوای کارت

محتوای کارت

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

string

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

description

string

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

media

object ( Media )

اختیاری. رسانه برای درج در کارت.

suggestions[]

object ( Suggestion )

اختیاری. لیست پیشنهاداتی که باید در کارت گنجانده شود. حداکثر 4 پیشنهاد

رسانه ها

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

نمایندگی JSON
{
  "height": enum (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
زمینه های
height

enum ( Height )

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

content زمینه اتحادیه محتوای رسانه. content فقط می تواند یکی از موارد زیر باشد:
contentInfo

object ( ContentInfo )

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

ارتفاع

ارتفاع رسانه

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

پیشنهاد

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

نمایندگی JSON
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
زمینه های
option فیلد اتحادیه یک پاسخ پیشنهادی option فقط می تواند یکی از موارد زیر باشد:
reply

object ( SuggestedReply )

پیشنهادی برای پاسخ به کاربر با متن مشخص شده.

action

object ( SuggestedAction )

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

liveAgentRequest

object ( LiveAgentRequest )

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

authenticationRequest

object ( AuthenticationRequest )

درخواستی برای شروع جریان احراز هویت.

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

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

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

string

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

postbackData

string

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

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

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

نمایندگی JSON
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
زمینه های
text

string

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

postbackData

string

رشته ای که وقتی کاربر روی عملکرد پیشنهادی ضربه می زند، عامل دریافت می کند. حداکثر 2048 کاراکتر.

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

object ( OpenUrlAction )

URL مشخص شده را باز می کند.

dialAction

object ( DialAction )

برنامه شماره گیر پیش فرض کاربر را باز می کند.

OpenUrlAction

URL مشخص شده را باز می کند.

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

string

URL

DialAction

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

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

string

ضروری. شماره تلفن مشخص شده، با فرمت RFC 3966 . به عنوان مثال، "+1-201-555-0123".

LiveAgentRequest

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

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

AuthenticationRequest

درخواست احراز هویت یک مکالمه

نمایندگی JSON
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
زمینه های
فیلد اتحادیه authentication_type . نوع احراز هویت authentication_type تنها می تواند یکی از موارد زیر باشد:
oauth

object ( Oauth )

جزئیات برای احراز هویت از طریق OAuth.

سوگند

جزئیات برای احراز هویت از طریق OAuth.

نمایندگی JSON
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
زمینه های
clientId

string

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

codeChallenge

string

ضروری. چالش کد مورد استفاده برای تبادل توکن های دسترسی.

scopes[]

string

ضروری. آرایه ای که محدوده درخواست را مشخص می کند.

codeChallengeMethod

string

اختیاری. روش چالش کد مورد استفاده برای ایجاد چالش کد. اگر این پارامتر حذف شود، سرور plain فرض می کند.

CarouselCard

چرخ فلک کارت.

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

enum ( CardWidth )

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

cardContents[]

object ( CardContent )

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

پهنای کارت

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

Enums
CARD_WIDTH_UNSPECIFIED مشخص نشده است
SMALL 136 DP. نمی توان رسانه های بلند را شامل شود.
MEDIUM 280 DP.

مواد و روش ها

create

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

updateReceipt

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