Method: users.batchGet

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

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

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

מקסימום 600 שאילתות לדקה (QPM).

חשוב: בשיטה users.batchGet צריך להשתמש בנקודות קצה אזוריות. הבקשות צריכות לכלול מספרי טלפון מאזור גיאוגרפי אחד. שליחת מספרי טלפון מכמה אזורים בבקשה אחת או שליחה לנקודת קצה אזורית שגויה תגרום לשגיאה 400 Bad Request.

נקודות קצה אזוריות:

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
שדות
users[]

string

רשימה של מספרי הטלפון של המשתמשים בפורמט E.164.

כל מספרי הטלפון בבקשה אחת צריכים להיות שייכים לאותו אזור גיאוגרפי. בקשות שמכילות מספרי טלפון מכמה אזורים או שנשלחות לנקודת קצה אזורית שגויה ייכשלו עם שגיאה 400 Bad Request.
agentId

string

חובה. המזהה הייחודי של הסוכן.

גוף התשובה

תשובה עם נתוני זמינות של משתמשים ב-RCS לעסקים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
שדות
reachableUsers[]

string

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

integer

מספר הטלפונים שנבחרו באופן אקראי מתוך reachableUsers. בדרך כלל הערך הזה הוא כ-75% ממספר הטלפונים הכולל שנדרש. הערך הזה הוא 0 אם מספר הטלפונים המבוקש קטן מ-500.
reachableRandomSampleUserCount

integer

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

map (key: string, value: object (ReachableUsers))

פלט בלבד. מיפוי של מזהה הספק לרשימה של משתמשים שאפשר להגיע אליהם אצל הספק הזה. השדה הזה מאוכלס רק עבור מספרי טלפון בארה"ב.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

ReachableUsers

רשימה של משתמשים שאפשר להגיע אליהם אצל ספק ספציפי.

ייצוג ב-JSON 
{
  "reachableUsers": [
    string
  ]
}
שדות
reachableUsers[]

string

רשימה של משתמשים שאפשר להגיע אליהם אצל ספק ספציפי. השדה הזה מאוכלס רק עבור מספרי טלפון בארה"ב.