Method: users.batchGet

تعرض هذه الطريقة أرقام الهواتف المفعَّل عليها RCS لقائمة من المستخدمين.

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

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

الحدّ الأقصى هو 600 طلب في الدقيقة.

طلب 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

قائمة بأرقام هواتف المستخدمين الذين يمكن الوصول إليهم من خلال ميزة "RCS للمؤسسات" تشمل هذه القائمة المستخدمين الذين يستخدمون شركات الاتصالات التي تم إطلاق الوكيل عليها.
totalRandomSampleUserCount

integer

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

integer

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

نطاقات الأذونات

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.