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 DP.
TALL و264 وحدة بكسل مستقلة الكثافة. هذه الميزة غير متاحة في لوحات العرض الدوّارة الخاصة ببطاقات البحث الذكية عند ضبط عرض البطاقة على 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. على سبيل المثال، "0123-555-201-1+".

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 DP. لا يمكن تضمين وسائط طويلة.
MEDIUM و280 وحدة بكسل مستقلة الكثافة.

الطُرق

create

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

updateReceipt

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