المورد: AgentMessage
رسالة مُرسَلة من الوكيل إلى المستخدم
تمثيل JSON |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
الحقول | |
---|---|
name |
يتم ضبط هذا الحقل من خلال منصة RBM. لا تُدرِجها عند إنشاء رسالة من وكيل الدعم. يحلّ الحقل "phones/{E.164}/agentMessages/{messageId}"، حيث {E.164} هو رقم هاتف المستخدم بتنسيق E.164 و{messageId} هو رقم تعريف رسالة الوكيل الذي عيّنه الوكيل. |
sendTime |
يتم ضبط هذا الحقل من خلال منصة RBM. لا تُدرِجها عند إنشاء رسالة من وكيل الدعم. يحلّ الحقل الوقت الذي يتم فيه إرسال الرسالة إلى المستخدم. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 و3 و6 و9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
contentMessage |
محتوى رسالة موظّف الدعم |
messageTrafficType |
نوع زيارات الرسالة. |
حقل الدمج يمكن أن تكون |
|
expireTime |
اختياريّ. طابع زمني بالتوقيت العالمي المتفق عليه يحدّد وقت انتهاء صلاحية هذا المرجع. يتم توفير هذه القيمة في الناتج إذا تم ضبطها أو إذا تم ضبط حقل TTL. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 و3 و6 و9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
ttl |
اختياريّ. الإدخال فقط تحدّد هذه السمة المدة التي ستكون فيها الرسالة صالحة قبل إبطالها تلقائيًا. مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ " |
AgentContentMessage
محتوى الرسالة المُرسَلة من الوكيل إلى المستخدم
تمثيل JSON |
---|
{ "suggestions": [ { object ( |
الحقول | |
---|---|
suggestions[] |
قائمة بالردود والإجراءات المقترَحة التي تظهر كقائمة من شرائح الاقتراحات بعد رسالة الموظف المرتبط بها يمكنك إدخال 11 اقتراحًا كحدّ أقصى. لا تظهر الشرائح إلا عندما تكون رسالة الوكيل المرتبطة بها هي أحدث رسالة في المحادثة (بما في ذلك رسائل الوكيل والمستخدم). يمكن للمستخدم النقر على ردّ مقترَح لإرسال الردّ النصي إلى الموظف أو النقر على إجراء مقترَح لبدء إجراء أصلي على الجهاز. يمكنك إدخال 11 اقتراحًا كحدّ أقصى. |
حقل الدمج content يمكن أن يكون محتوى رسالة وكيل الدعم content أحد الخيارات التالية فقط: |
|
text |
نص مرمّز بتنسيق UTF-8 الحد الأقصى 3072 حرفًا. |
fileName |
الاسم الفريد للملف تعرض منصة RBM اسم ملف عندما يحمّل الوكيل ملفًا. تم إيقافها نهائيًا واستبدالها بالسمة uploadedRbmFile أدناه |
uploadedRbmFile |
يحتوي على معرّفات لملف وصورة مصغّرة تم تحميلهما إلى خادم RBM وعرضهما من خلاله |
richCard |
بطاقة تفاعلية مستقلة |
contentInfo |
معلومات عن ملف، بما في ذلك عنوان URL للملف وعنوان URL للصورة المصغّرة للملف تعرض منصة RBM المحتوى من ذاكرة تخزين مؤقت، ولكن يمكن للوكيل أن يفرض على منصة RBM جلب إصدار جديد من المحتوى وتحديث ذاكرة التخزين المؤقت. |
UploadedRbmFile
رسالة تحتوي على معلومات الملف والصورة المصغّرة
تمثيل JSON |
---|
{ "fileName": string, "thumbnailName": string } |
الحقول | |
---|---|
fileName |
اسم الملف الذي تعرضه منصة "المراسلة الغنية التفاعلية" عند تحميل الملف |
thumbnailName |
اسم الصورة المصغّرة الذي تعرضه منصة RBM عند تحميل الصورة المصغّرة |
RichCard
بطاقة تفاعلية مستقلة أو مجموعة من البطاقات التفاعلية أرسلها الوكيل إلى المستخدم
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الدمج card بطاقة مستقلة أو لوحة عرض دوّارة لبطاقات يمكن أن تكون card إحدى القيم التالية فقط: |
|
carouselCard |
لوحة عرض دوّارة للبطاقات |
standaloneCard |
بطاقة مستقلة |
CarouselCard
لوحة عرض دوّارة للبطاقات
تمثيل JSON |
---|
{ "cardWidth": enum ( |
الحقول | |
---|---|
cardWidth |
تمثّل هذه السمة عرض البطاقات في لوحة العرض الدوّارة. |
cardContents[] |
قائمة المحتوى لكل بطاقة في لوحة العرض الدوّارة. يمكن أن يحتوي دوّار العرض على بطاقتَين كحدّ أدنى و10 بطاقات كحدّ أقصى. |
CarouselCard.CardWidth
تمثّل هذه السمة عرض البطاقات في لوحة العرض الدوّارة.
عمليات التعداد | |
---|---|
CARD_WIDTH_UNSPECIFIED |
لم يتم تحديد أي قيمة. |
SMALL |
120 نقطة ولاء يُرجى العِلم أنّه لا يمكن استخدام الوسائط الطويلة. |
MEDIUM |
232 نقطة |
CardContent
محتوى البطاقة
تمثيل JSON |
---|
{ "title": string, "description": string, "media": { object ( |
الحقول | |
---|---|
title |
(اختياري) عنوان البطاقة الحد الأقصى 200 حرف |
description |
(اختياري) وصف البطاقة يمكن استخدام 2000 حرف كحدّ أقصى. |
media |
(اختياري) وسائط (صورة أو صورة GIF أو فيديو أو ملف PDF) لتضمينها في البطاقة |
suggestions[] |
(اختياري) قائمة بالاقتراحات التي سيتم تضمينها في البطاقة. يمكنك إضافة 4 اقتراحات كحدّ أقصى. |
الوسائط
ملف وسائط ضمن بطاقة تفاعلية
تمثيل JSON |
---|
{ "height": enum ( |
الحقول | |
---|---|
height |
تمثّل هذه السمة ارتفاع الوسائط ضمن بطاقة تفاعلية بتصميم عمودي. بالنسبة إلى البطاقة المستقلة ذات التنسيق الأفقي، لا يمكن تخصيص الارتفاع، وسيتم تجاهل هذا الحقل. |
حقل الدمج content يمكن أن يكون محتوى الوسائط content أحد الخيارات التالية فقط: |
|
fileName |
الاسم الفريد للملف، والذي تعرضه منصة "المراسلة الغنية بالعلامات التجارية" عند تحميل الملف تم إيقافها نهائيًا واستبدالها بالسمة uploadedRbmFile أدناه |
uploadedRbmFile |
يحتوي على معرّفات لملف وصورة مصغّرة تم تحميلهما إلى خادم RBM وعرضهما من خلاله |
contentInfo |
معلومات عن ملف، بما في ذلك عنوان URL للملف وعنوان URL للصورة المصغّرة للملف تعرض منصة RBM المحتوى من ذاكرة تخزين مؤقت، ولكن يمكن للوكيل أن يفرض على منصة RBM جلب إصدار جديد من المحتوى وتحديث ذاكرة التخزين المؤقت. |
ContentInfo
رسالة تحتوي على معلومات المحتوى
تمثيل JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
الحقول | |
---|---|
fileUrl |
عنوان URL للملف يمكن الوصول إليه بشكل علني. تحدّد منصة RBM نوع MIME للملف من حقل نوع المحتوى في عناوين HTTP عندما تسترد المنصة الملف. يجب أن يكون حقل نوع المحتوى متوفّرًا ودقيقًا في استجابة HTTP من عنوان URL. ننصح بأن يكون الحد الأقصى لحجم الملف 100 ميغابايت. ملاحظة: لا تتوفّر عمليات إعادة التوجيه في عناوين URL للملفات. يُرجى استخدام CreateFileRequest إذا كانت هناك حاجة إلى إعادة التوجيه. |
thumbnailUrl |
(اختيارية، لملفات الصور والصوت والفيديو فقط) عنوان URL للصورة المصغّرة يمكن الوصول إليه بشكل علني. الحدّ الأقصى للحجم هو 100 كيلوبايت. في حال عدم تقديم عنوان URL لصورة مصغّرة، تعرض منصة RBM صورة مصغّرة فارغة إلى أن ينزّل جهاز المستخدم الملف. استنادًا إلى إعدادات المستخدم، قد لا يتم تنزيل الملف تلقائيًا وقد يتطلّب ذلك أن ينقر المستخدم على زر التنزيل. ملاحظة: لا تتوفّر عمليات إعادة التوجيه في عناوين URL للملفات. يُرجى استخدام CreateFileRequest إذا كانت هناك حاجة إلى إعادة التوجيه. |
forceRefresh |
في حال ضبط هذه السمة، تجلب منصة RBM الملف والصورة المصغّرة من عناوين URL المحدّدة، حتى إذا كانت المنصة تحتفظ بنسخ مخزّنة مؤقتًا من الملف (أو الصورة المصغّرة). |
Media.Height
ارتفاع الوسائط
عمليات التعداد | |
---|---|
HEIGHT_UNSPECIFIED |
لم يتم تحديد أي قيمة. |
SHORT |
112 نقطة |
MEDIUM |
168 نقطة DP. |
TALL |
264 نقطة ولاء لا تتوفّر هذه الميزة في لوحات عرض دوّارة للبطاقات التفاعلية عندما يكون عرض البطاقة مضبوطًا على "صغير". |
اقتراح
ردّ مقترَح أو إجراء مقترَح مضمّن في بطاقة تفاعلية أو في قائمة شرائح اقتراحات
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الدمج option يمكن أن يكون الرد المقترَح أو الإجراء المقترَح option أحد الخيارات التالية فقط: |
|
reply |
يمكن للمستخدمين النقر على ردّ مقترَح لإرسال الردّ النصي إلى الموظف. |
action |
يمكن للمستخدمين النقر على إجراء مقترَح لبدء الإجراء الأصلي المقابل على الجهاز. |
SuggestedReply
عند النقر عليه، يتم إرسال الرد النصي إلى الوكيل.
تمثيل JSON |
---|
{ "text": string, "postbackData": string } |
الحقول | |
---|---|
text |
النص الذي يظهر في الردّ المقترَح ويتم إرساله إلى الموظف عند نقر المستخدم عليه. يمكن استخدام 25 حرفًا كحدّ أقصى. |
postbackData |
الحِمل المرمّز بتنسيق base64 الذي يتلقّاه الوكيل في حدث مستخدم عندما ينقر المستخدم على الردّ المقترَح. |
SuggestedAction
عند النقر عليه، يتم بدء الإجراء الأصلي المقابل على الجهاز.
تمثيل JSON |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
الحقول | |
---|---|
text |
النص الذي يظهر في الإجراء المقترَح يمكن استخدام 25 حرفًا كحدّ أقصى. |
postbackData |
الحمولة (ترميز base64) التي سيتم إرسالها إلى موظّف الدعم في حدث المستخدم الذي ينتج عندما ينقر المستخدم على الإجراء المقترَح. الحد الأقصى لعدد الأحرف هو 2048 حرفًا. |
fallbackUrl |
(اختياري) عنوان URL احتياطي لاستخدامه إذا كان أحد العملاء لا يتيح إجراءً مقترَحًا. تُفتح عناوين URL الاحتياطية في نوافذ متصفّح جديدة. يجب أن يكون معرّف موارد منتظمًا صالحًا وفقًا للمعيار RFC 3986. الحد الأقصى لعدد الأحرف هو 2048 حرفًا. |
حقل الدمج action يمكن أن يكون الإجراء الأصلي الذي تم تنفيذه على الجهاز عندما ينقر المستخدم على الإجراء المقترَح action أحد الإجراءات التالية فقط: |
|
dialAction |
يفتح تطبيق الاتصال التلقائي للمستخدم مع ملء رقم الهاتف الذي حدّده الموظف. |
viewLocationAction |
يفتح تطبيق الخرائط التلقائي للمستخدم ويختار الموقع الجغرافي الذي حدّده الوكيل أو يبحث في محيط الموقع الجغرافي للمستخدم استنادًا إلى طلب حدّده الوكيل. |
createCalendarEventAction |
يفتح تطبيق التقويم التلقائي للمستخدم ويبدأ مسار حدث التقويم الجديد مع ملء بيانات الحدث المحدّدة من قِبل الوكيل مسبقًا. |
openUrlAction |
يفتح تطبيق متصفّح الويب التلقائي للمستخدم على عنوان URL المحدّد. إذا كان لدى المستخدم تطبيق مثبَّت تم تسجيله كمعالج تلقائي لعنوان URL، سيتم فتح هذا التطبيق بدلاً من ذلك، وسيتم استخدام رمزه في واجهة المستخدم الخاصة بالإجراء المقترَح. |
shareLocationAction |
يفتح أداة اختيار الموقع الجغرافي في تطبيق RCS ليتمكّن المستخدم من اختيار موقع جغرافي لإرساله إلى الوكيل. |
DialAction
يفتح تطبيق الاتصال التلقائي للمستخدم مع ملء رقم الهاتف الذي حدّده الموظف.
تمثيل JSON |
---|
{ "phoneNumber": string } |
الحقول | |
---|---|
phoneNumber |
رقم الهاتف بتنسيق E.164، على سبيل المثال +12223334444 |
ViewLocationAction
يفتح تطبيق الخرائط التلقائي للمستخدم ويختار الموقع الجغرافي الذي حدّده الوكيل أو يبحث في محيط الموقع الجغرافي للمستخدم استنادًا إلى طلب حدّده الوكيل.
تمثيل JSON |
---|
{
"latLong": {
object ( |
الحقول | |
---|---|
latLong |
(اختياري) تمثّل هذه السمة خط العرض وخط الطول للموقع الجغرافي المحدّد. |
label |
(اختياري) تصنيف الدبوس الذي تم وضعه في latLong |
query |
(اختياري، متاح فقط على عملاء "رسائل Google") بدلاً من تحديد latLong (ويمكنك اختياريًا تحديد تصنيف)، يمكن للوكيل بدلاً من ذلك تحديد سلسلة طلب بحث. بالنسبة إلى تطبيقات الخرائط التلقائية التي تتيح وظيفة البحث (بما في ذلك "خرائط Google")، يؤدي النقر على هذا الإجراء المقترَح إلى إجراء بحث عن موقع جغرافي يركّز على الموقع الجغرافي الحالي للمستخدم. إذا كان طلب البحث محدّدًا بشكل كافٍ، يمكن للوكلاء استخدامه لاختيار أي موقع جغرافي في العالم. على سبيل المثال، سيؤدي ضبط سلسلة طلب البحث على "Growing Tree Bank" إلى عرض جميع مواقع Growing Tree Bank القريبة من المستخدم. سيؤدي ضبط سلسلة طلب البحث على "1600 Amphitheater Parkway, Mountain View, CA 94043" إلى اختيار هذا العنوان المحدّد، بغض النظر عن الموقع الجغرافي للمستخدم. |
LatLng
كائن يمثّل زوجًا من خطوط الطول والعرض يتم التعبير عن ذلك كزوج من الأرقام المضاعفة لتمثيل درجات خط العرض ودرجات خط الطول. ما لم يُحدّد خلاف ذلك، يجب أن يتوافق هذا العنصر مع معيار WGS84. يجب أن تكون القيم ضمن النطاقات العادية.
تمثيل JSON |
---|
{ "latitude": number, "longitude": number } |
الحقول | |
---|---|
latitude |
تمثّل هذه السمة خط العرض بالدرجات. يجب أن يكون ضمن النطاق [-90.0, +90.0]. |
longitude |
خط الطول بالدرجات يجب أن تكون القيمة ضمن النطاق [-180.0, +180.0]. |
CreateCalendarEventAction
يفتح تطبيق التقويم التلقائي للمستخدم ويبدأ مسار حدث التقويم الجديد مع ملء بيانات الحدث المحدّدة من قِبل الوكيل مسبقًا.
تمثيل JSON |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
الحقول | |
---|---|
startTime |
وقت بدء الحدث يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 و3 و6 و9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
endTime |
تمثّل هذه السمة وقت انتهاء الحدث. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 و3 و6 و9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
title |
تمثّل هذه السمة عنوان الحدث. الحد الأقصى لعدد الأحرف هو 100 حرف. |
description |
وصف الحدث 500 حرف كحدّ أقصى |
OpenUrlAction
يفتح تطبيق متصفّح الويب التلقائي للمستخدم على عنوان URL المحدّد. إذا كان لدى المستخدم تطبيق مثبَّت تم تسجيله كمعالج تلقائي لعنوان URL، سيتم فتح هذا التطبيق بدلاً من ذلك، وسيتم استخدام رمزه في واجهة المستخدم الخاصة بالإجراء المقترَح.
تمثيل JSON |
---|
{ "url": string, "application": enum ( |
الحقول | |
---|---|
url |
عنوان URL المطلوب فتحه اعتبارًا من 1 نوفمبر 2025، يجب أن يكون مخطط عنوان URL هو https:// أو http://. سيتم رفض طلبات واجهة برمجة التطبيقات التي تستخدم أي مخططات أخرى (مثل tel: أو mailto: أو sms:) مع ظهور الخطأ 400 Bad Request بعد هذا التاريخ. يجب أن يكون عنوان URL معرّف موارد منتظمًا صالحًا وفقًا للمعيار RFC 3986. الحد الأقصى لعدد الأحرف هو 2048 حرفًا. |
application |
تطبيق أو متصفّح أو Webview لفتح عنوان URL للتحقّق ممّا إذا كان جهاز المستخدم يتيح وضع العرض على الويب، عليك إجراء فحص للتأكّد من توفّر الإمكانية أولاً. يمكنك الاطّلاع على المستندات للحصول على التفاصيل: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
وضع العرض في WebView |
description |
وصف تسهيل الاستخدام الخاص بعرض الويب |
OpenUrlApplication
نوع التطبيق الذي يفتح عنوان URL
عمليات التعداد | |
---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
لم يتم تحديد أي خيار، وسيتم استخدام المتصفّح لفتح الملف. |
BROWSER |
استخدِم المتصفّح لفتح عنوان URL. |
WEBVIEW |
فتح عنوان URL في نافذة عرض ويب مدمجة |
WebviewViewMode
نوع وضع عرض WebView.
عمليات التعداد | |
---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
لم يتم تحديد أي قيمة. لاستخدام webview، يجب تحديد وضع عرض. |
FULL |
يجب أن تتضمّن تراكبًا بملء الشاشة مع تصنيف محادثة روبوت الدردشة ضمن شريط الحالة. |
HALF |
يتطلّب ذلك استخدام تراكب على نصف الشاشة. |
TALL |
يتطلّب ذلك تراكبًا على ثلاثة أرباع الشاشة. |
StandaloneCard
بطاقة مستقلة
تمثيل JSON |
---|
{ "cardOrientation": enum ( |
الحقول | |
---|---|
cardOrientation |
اتجاه البطاقة |
thumbnailImageAlignment |
محاذاة معاينة الصور للبطاقات المستقلة ذات التصميم الأفقي |
cardContent |
محتوى البطاقة |
StandaloneCard.CardOrientation
اتجاه البطاقة
عمليات التعداد | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
لم يتم تحديد أي قيمة. |
HORIZONTAL |
تنسيق أفقي إذا كان |
VERTICAL |
تخطيط عمودي |
StandaloneCard.ThumbnailImageAlignment
محاذاة معاينة الصور للبطاقات المستقلة ذات التصميم الأفقي
عمليات التعداد | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
لم يتم تحديد أي قيمة. |
LEFT |
تتم محاذاة معاينة الملف إلى اليمين. |
RIGHT |
تتم محاذاة معاينة الملف إلى اليسار. |
MessageTrafficType
أنواع زيارات الرسائل المتوافقة سيتم توسيع التعداد لدعم أنواع زيارات إضافية.
عمليات التعداد | |
---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
السلوك التلقائي: يتم تحديد نوع زيارات الرسائل حسب حالة استخدام الوكيل. عدِّل نوع الزيارات حسب الحاجة استنادًا إلى محتوى الرسالة. بالنسبة إلى الوكلاء متعدّدي الاستخدام، لا يتم توفير أي إعداد تلقائي. يجب ضبط نوع الزيارات يدويًا (على سبيل المثال، المعاملات والعروض الترويجية). |
AUTHENTICATION |
لرسائل المصادقة في حالة استخدام وكيل كلمة المرور لمرة واحدة. |
TRANSACTION |
بالنسبة إلى رسائل المعاملات في حالات استخدام "الوكيل" للمعاملات أو الاستخدام المتعدّد |
PROMOTION |
لرسائل العروض الترويجية في حالات استخدام "الوكيل الترويجي" أو "الوكيل المتعدّد الاستخدامات" |
SERVICEREQUEST |
لإرسال رسائل حول الخدمات التي وافق المستخدم على تلقّيها يُستخدم في حالات استخدام الوكيل لمرة واحدة أو المعاملات أو الترويج أو الاستخدام المتعدد. |
ACKNOWLEDGEMENT |
بالنسبة إلى الرسائل التي تقرّ باستلام طلب إلغاء الاشتراك من المستخدم يُستخدم في حالات استخدام الوكيل لمرة واحدة أو المعاملات أو الترويج أو الاستخدام المتعدد. |
الطُرق |
|
---|---|
|
يرسل رسالة من الوكيل إلى المستخدم. |
|
تلغي هذه الطريقة رسالة من وكيل تم إرسالها ولكن لم يتم تسليمها بعد. |