Method: users.batchGet

الحصول على أرقام الهواتف المتوافقة مع خدمات الاتصالات التفاعلية (RCS) لقائمة من المستخدمين

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

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

600 طلب في الدقيقة كحدّ أقصى (QPM).

طلب HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
الحقول
users[]

string

قائمة بأرقام هواتف المستخدمين بتنسيق E.164
agentId

string

مطلوبة. المعرِّف الفريد للوكيل

نص الاستجابة

استجابة باستخدام بيانات المستخدم التي يمكن الوصول إليها من خلال ميزة "مراسلة الأنشطة التجارية من خلال خدمات الاتصالات التفاعلية (RCS)"

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
الحقول
reachableUsers[]

string

قائمة بأرقام هواتف المستخدمين التي يمكن أن تصل إليها ميزة RBM. لا يتضمن هذا الخيار سوى مستخدمي شركات تشغيل شبكات الجوّال التي تم إطلاق الوكيل عليها.
totalRandomSampleUserCount

integer

عدد أرقام الهواتف التي تم اختيارها عشوائيًا من reachableUsers. وتمثل هذه القيمة عادةً 75% تقريبًا من إجمالي أرقام الهواتف المطلوبة. وتبلغ هذه القيمة 0 إذا كان عدد أرقام الهاتف المطلوبة أقل من 500.
reachableRandomSampleUserCount

integer

عدد أرقام الهواتف من القائمة التي تم اختيارها عشوائيًا والتي يمكن الوصول إليها عبر خدمات الاتصالات التفاعلية (RCS) من خلال جميع مشغّلي شبكات الجوّال، بغض النظر عن حالة إطلاق الوكيل ويمكن أن تؤدي النسبة بين هذه القيمة وtotalRandomSampleUserCount إلى تقريب مدى الوصول المحتمل إلى قائمة من المستخدمِين.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.