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

اسم الرسالة، كما هو محدد في ميزة "الرسائل التجارية". يبدأ الخيار في "conversations/{conversationId}/messages/{messageId}"، حيث يكون {conversationId} هو المعرّف الفريد للمحادثة و{messageId} هو المعرّف الفريد للرسالة.
messageId

string

مطلوبة. المعرّف الفريد للرسالة الذي يخصّصه الوكيل وإذا حاولت رسالة استخدام نفس messageId في رسالة سابقة، قد يتأثر التسليم الصحيح للرسالة.
representative

object (Representative)

تفاصيل عن الممثل (الشخصي أو برنامج الدردشة المبرمَجة) الذي أرسل الرسالة.
suggestions[]

object (Suggestion)

قائمة بالردود المقترحة التي تظهر كقائمة من شرائح الاقتراحات بعد الرسالة المرتبطة. الحد الأقصى هو 13 اقتراحًا.

لا يتم عرض الشرائح إلا عندما تكون الرسالة المرتبطة بها أحدث رسالة في المحادثة (بما في ذلك رسائل الوكيل والمستخدم). يمكن للمستخدم النقر على رد مقترَح لإرسال ردّ نصي إلى موظّف الدعم.
fallback

string

اختياريّ. نص احتياطي يتم عرضه إذا كان جهاز المستخدم لا يتيح نوع الرسالة أو محتواها. الحد الأقصى لعدد الأحرف هو 3,072 حرفًا.
containsRichText

boolean

اختياريّ. إذا كان true، يشير إلى احتواء الرسالة على نص منسق. إذا كانت الرسالة تحتوي على تنسيق غير صالح، تعرض ميزة "الرسائل التجارية" رسالة خطأ.
حقل الاتحاد content محتوى رسالة. يمكن أن تكون السمة "content" واحدة فقط مما يلي:
text

string

رسالة نصية الحد الأقصى لعدد الأحرف هو 3,072 حرفًا.
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)

معلومات حول صورة معيّنة، بما في ذلك عنوان URL للصورة وعنوان URL للصورة المصغّرة

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

نص يصف تفاصيل الوسائط لأغراض تسهيل الاستخدام.

RichCard

بطاقة تفاعلية مستقلة أو لوحة عرض دوّارة للبطاقات التفاعلية المُرسَلة من الوكيل إلى المستخدم.

تمثيل 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)

لوحة عرض دوّارة للبطاقات

StandaloneCard

بطاقة مستقلة.

تمثيل JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
الحقول
cardContent

object (CardContent)

محتوى البطاقة:

CardContent

محتوى البطاقة:

تمثيل JSON 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
الحقول
title

string

اختياريّ. عنوان البطاقة. الحد الأقصى لعدد الأحرف هو 200 حرف.
description

string

اختياريّ. وصف البطاقة الحد الأقصى لعدد الأحرف هو 2,000 حرف.
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)

معلومات عن ملف، بما في ذلك عنوان URL للملف وعنوان URL للصورة المصغّرة للملف

الطول

ارتفاع الوسائط

عمليات التعداد
HEIGHT_UNSPECIFIED غير محدَّد.
SHORT 112 وحدة بكسل
MEDIUM 168 وحدة بكسل
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)

طلب لبدء مسار المصادقة.

SuggestedReply

عند النقر على الزر، يتم إرسال الردّ النصي إلى موظّف الدعم.

تمثيل JSON 
{
  "text": string,
  "postbackData": string
}
الحقول
text

string

نص يظهر في الردّ المقترَح ويتم إرساله إلى الوكيل عندما ينقر المستخدم عليه. الحد الأقصى لعدد الأحرف هو 25 حرفًا.
postbackData

string

السلسلة التي يتلقّاها الوكيل عندما ينقر المستخدم على الرد المقترَح. الحد الأقصى لعدد الأحرف هو 2,048 حرفًا.

SuggestedAction

عند النقر على الزر، يتم بدء الإجراء الأصلي المقابل على الجهاز.

تمثيل 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

السلسلة التي يتلقّاها الوكيل عندما ينقر المستخدم على الإجراء المقترَح. الحد الأقصى لعدد الأحرف هو 2,048 حرفًا.
حقل الاتحاد 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

تفاصيل حول المصادقة عبر بروتوكول 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)

قائمة المحتوى لكل بطاقة في لوحة العرض الدوّارة يمكن أن تتضمّن لوحة العرض الدوّارة بطاقتَين كحدّ أدنى و10 بطاقات كحدّ أقصى.

CardWidth

عرض البطاقات في لوحة العرض الدوّارة.

عمليات التعداد
CARD_WIDTH_UNSPECIFIED صيغة مخاطبة غير محدَّدة
SMALL 136 وحدة بكسل لا يمكن تضمين وسائط طويلة.
MEDIUM 280 نقطة.

الطُرق

create

 يرسل رسالة من وكيل إلى مستخدم.

updateReceipt

 لإرسال إيصال برسالة من وكيل إلى مستخدم.