Method: users.batchGet

מקבלת את מספרי הטלפון התומכים ב-RCS לרשימת משתמשים.

המטען הייעודי שמוחזר מכיל רשימה של מספרי טלפון התומכים ב-RCS, שפלטפורמת RBM יכולה להגיע אליהם עבור המשתמשים שצוינו. יוחזרו רק מספרי טלפון שתומכים ב-RCS אצל ספק שהנציג הופעל בו.

המטען הייעודי (payload) שהוחזר מכיל גם ערכים שאפשר להשתמש בהם כדי להעריך את פוטנציאל החשיפה של רשימת מספרי טלפון, בלי קשר לסטטוס ההפעלה של הנציג.

עד 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.