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

يتم ضبط هذا الحقل من خلال النظام الأساسي لميزة "مراسلة الأنشطة التجارية من خلال خدمات الاتصالات التفاعلية (RCS)". لا تدرِج هذه المعلومات عند إنشاء رسالة موظّف دعم. يحل الحقل "phones/{E.164}/agentMessages/{messageId}"، حيث يكون {E.164} هو رقم هاتف المستخدم بالتنسيق E.164 و{messageId} هي المعرِّف الذي يخصّصه الوكيل لرسالة الوكيل.

sendTime

string (Timestamp format)

يتم ضبط هذا الحقل من خلال النظام الأساسي لميزة "مراسلة الأنشطة التجارية من خلال خدمات الاتصالات التفاعلية (RCS)". لا تدرِج هذه المعلومات عند إنشاء رسالة موظّف دعم. يحل هذا الحقل وقت إرسال الرسالة إلى المستخدم.

طابع زمني بتنسيق 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 للصورة المصغّرة للملف

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

UploadedRbmFile

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

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

string

اسم الملف الذي يعرضه النظام الأساسي "مراسلة الأنشطة التجارية من خلال خدمات الاتصالات التفاعلية (RCS)" عند تحميل الملف.

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 للصورة المصغّرة للملف

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

ContentInfo

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

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

string

عنوان URL للملف يمكن الوصول إليه علانيةً. يحدد النظام الأساسي لـ RBM نوع MIME للملف من حقل نوع المحتوى في عناوين HTTP عندما يجلب النظام الأساسي الملف. يجب أن يكون حقل نوع المحتوى متوفرًا ودقيقًا في استجابة HTTP من عنوان URL. الحد الأقصى الموصى به لحجم الملف هو 100 ميغابايت.

thumbnailUrl

string

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

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

forceRefresh

boolean

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

Media.Height

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

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

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

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")، النقر على نتائج الإجراء المقترَحة هذه في بحث عن الموقع الجغرافي يتمحور حول الموقع الجغرافي الحالي للمستخدم وإذا كان طلب البحث محدّدًا بما فيه الكفاية، يمكن للوكلاء استخدامه لاختيار أي موقع جغرافي في العالم.

على سبيل المثال، يؤدي ضبط سلسلة طلب البحث على "Growing Tree Bank" إلى عرض جميع مواقع بنك Growing Tree Bank في المنطقة المجاورة للمستخدم. سيؤدي ضبط سلسلة طلب البحث على "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

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