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.