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)

اختياريّ. الطابع الزمني بالتوقيت العالمي المنسَّق لوقت اعتبار هذا المورد منتهي الصلاحية. ويتم تقديم هذه القيمة في الإخراج في حال ضبطها أو في حال ضبط حقل TTL.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
ttl

string (Duration format)

اختياريّ. الإدخال فقط. مدة عرض الرسالة قبل إبطالها تلقائيًا

مدة بالثواني يصل عددها إلى تسعة أرقام كسرية وتنتهي بـ "s". مثال: "3.5s".

AgentContentMessage

محتوى رسالة مُرسَلة من الوكيل إلى مستخدم

تمثيل 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 اسم ملف عندما يحمِّل وكيل ملفًا. تم إيقافها لصالح الملف الذي تم تحميلهRbmFile أدناه
uploadedRbmFile

object (UploadedRbmFile)

يحتوي على معرّفات لملف وصورة مصغّرة تم تحميلهما إلى خادم RBM وعرضهما.
richCard

object (RichCard)

بطاقة تفاعلية مستقلة.
contentInfo

object (ContentInfo)

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

ويعرض النظام الأساسي ميزة "مراسلة نصية في الوقت الفعلي" المحتوى من ذاكرة التخزين المؤقت، ولكن يمكن للوكيل أن يفرض على النظام الأساسي لهذه الميزة استرجاع نسخة جديدة من المحتوى وإعادة تحميل ذاكرة التخزين المؤقت.

UploadedRbmFile

رسالة تحتوي على معلومات عن الملف والصورة المصغّرة

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

string

اسم الملف الذي عرضه النظام الأساسي RBM عند تحميل الملف.
thumbnailName

string

اسم الصورة المصغّرة الذي تعرضه منصة RBM عند تحميل الصورة المصغّرة

RichCard

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

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

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

CarouselCard.CardWidth

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

عمليات التعداد
CARD_WIDTH_UNSPECIFIED عدم تحديد صيغة مخاطبة
SMALL 120 وحدة بكسل مستقلة الكثافة تجدر الإشارة إلى أنّه لا يمكن استخدام الوسائط الطويلة.
MEDIUM 232 وحدة بكسل مستقلة الكثافة

CardContent

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

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

string

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

string

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

object (UploadedRbmFile)

يحتوي على معرّفات لملف وصورة مصغّرة تم تحميلهما إلى خادم RBM وعرضهما.
contentInfo

object (ContentInfo)

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

ويعرض النظام الأساسي ميزة "مراسلة نصية في الوقت الفعلي" المحتوى من ذاكرة التخزين المؤقت، ولكن يمكن للوكيل أن يفرض على النظام الأساسي لهذه الميزة استرجاع نسخة جديدة من المحتوى وإعادة تحميل ذاكرة التخزين المؤقت.

ContentInfo

رسالة تتضمّن معلومات المحتوى

تمثيل JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
الحقول
fileUrl

string

عنوان URL للملف الذي يمكن الوصول إليه علنًا يحدد النظام الأساسي RBM نوع MIME للملف من حقل نوع المحتوى في عناوين HTTP عندما يجلب النظام الأساسي الملف. يجب أن يكون حقل "content-type" (نوع المحتوى) متوفّرًا ودقيقًا في استجابة HTTP من عنوان URL. الحد الأقصى المقترَح لحجم الملف هو 100 ميغابايت.
thumbnailUrl

string

(اختيارية، لملفات الصور والفيديو فقط) عنوان URL للصورة المصغّرة يمكن الوصول إليه بشكل علني الحدّ الأقصى للحجم 100 كيلو بايت.

إذا لم تقدّم عنوان URL لصورة مصغّرة، ستعرض منصة RBM صورة مصغّرة فارغة لعنصر نائب إلى أن ينزِّل جهاز المستخدم الملف. وفقًا لإعدادات المستخدم، قد لا يتم تنزيل الملف تلقائيًا وقد يتطلب من المستخدم النقر على زر التنزيل.
forceRefresh

boolean

وفي حال ضبطها، تجلب منصة RBM الملف والصورة المصغّرة من عناوين URL المحدّدة، حتى إذا كان النظام الأساسي يحتوي على نُسخ مخزّنة مؤقتًا من الملف (و/أو الصورة المصغّرة).

Media.Height

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

عمليات التعداد
HEIGHT_UNSPECIFIED عدم تحديد صيغة مخاطبة
SHORT 112 وحدة بكسل مستقلة الكثافة
MEDIUM 168 وحدة بكسل مستقلة الكثافة
TALL 264 وحدة بكسل مستقلة الكثافة لا يتوفّر هذا الخيار لمنصّات العرض بعناصر متغيّرة للبطاقات التفاعلية عند ضبط عرض البطاقة على صغير.

الاقتراح

ردّ مقترَح أو إجراء مقترَح مضمّن في بطاقة تفاعلية أو ضمن قائمة شرائح الاقتراحات

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

يمكن للمستخدمين النقر على إجراء مقترَح لبدء الإجراء الأصلي المناسب على الجهاز.

SuggestedReply

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

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

string

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

string

الحمولة بترميز base64 التي يتلقّاها الوكيل في حدث المستخدم عندما ينقر المستخدم على الرد المقترح.

SuggestedAction

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

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

الحمولة (بترميز base64) التي سيتم إرسالها إلى الوكيل في حدث المستخدم الذي ينتج عندما ينقر المستخدم على الإجراء المقترح
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

(اختياري) تصنيف الدبوس الذي تم إسقاطه عند خط الطول والعرض
query

string

(اختياري، متاح فقط على برامج رسائل Android) بدلاً من تحديد خط الطول والعرض (واختياريًا، تصنيف)، يمكن للوكيل تحديد سلسلة طلب بحث بدلاً من ذلك. بالنسبة إلى تطبيقات الخرائط التلقائية التي تتيح وظيفة البحث (بما في ذلك "خرائط Google")، يمكنك النقر على هذا الإجراء المقترَح في بحث عن موقع جغرافي يتمركز حول الموقع الجغرافي الحالي للمستخدم. إذا كان طلب البحث محدّدًا بشكل كافٍ، يمكن لموظّفي الدعم استخدامه لاختيار أي موقع جغرافي في العالم.

على سبيل المثال، سيؤدي ضبط سلسلة طلب البحث على "بنك شجرة العائلة" إلى عرض جميع مواقع بنك تنمية الشجرة في المنطقة المجاورة للمستخدم. يؤدي ضبط سلسلة طلب البحث على "1600 Amphitheater 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 ليتمكّن المستخدم من اختيار موقع جغرافي لإعادة إرساله إلى الوكيل.

StandaloneCard

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

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

اتجاه البطاقة

عمليات التعداد
CARD_ORIENTATION_UNSPECIFIED عدم تحديد صيغة مخاطبة
HORIZONTAL

التخطيط الأفقي.

إذا كانت البطاقة التفاعلية الأفقية object(CardContent) تضمّ الحقل media، يجب أن تتضمّن أيضًا الحقل title أو description أو suggestions[] على الأقل.
VERTICAL التخطيط العمودي.

StandaloneCard.ThumbnailImageAlignment

محاذاة معاينة الصورة للبطاقات المستقلة مع التنسيق الأفقي

عمليات التعداد
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED عدم تحديد صيغة مخاطبة
LEFT تمت محاذاة معاينة الملف إلى اليسار.
RIGHT تمت محاذاة معاينة الملف إلى اليمين.

الطُرق

create

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

delete

 يؤدي إلى إبطال رسالة الوكيل التي تم إرسالها ولكن لم يتم تسليمها بعد.