Method: users.batchGet

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

تحتوي الحمولة التي تم عرضها على قائمة بأرقام الهواتف المزوّدة بخدمة RCS، والتي يمكن للمستخدمين المحدّدين الوصول إليها من خلال منصة RBM. لن يتم عرض سوى أرقام الهواتف المزوّدة بخدمة 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

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

نص الاستجابة

الاستجابة لبيانات المستخدمين التي تتيح الوصول إلى RBM

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

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