Method: users.batchGet

Pobiera numery telefonów z włączoną obsługą RCS dla listy użytkowników.

Zwrócony ładunek zawiera listę numerów telefonów obsługujących RCS, które są dostępne na platformie RCS dla firm dla określonych użytkowników. Zostaną zwrócone tylko numery telefonów, które obsługują RCS w przypadku operatora, u którego uruchomiono agenta.

Zwrócony ładunek zawiera też wartości, które można wykorzystać do oszacowania potencjalnego zasięgu listy numerów telefonów niezależnie od stanu wdrożenia agenta.

Maksymalnie 600 zapytań na minutę (QPM).

Ważne: metoda users.batchGet wymaga użycia regionalnych punktów końcowych. Żądania muszą zawierać numery telefonów z jednego regionu geograficznego. Wysyłanie numerów telefonów z wielu regionów w jednym żądaniu lub wysyłanie ich do nieprawidłowego regionalnego punktu końcowego spowoduje wystąpienie błędu 400 Bad Request.

Regionalne punkty końcowe:

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Pola
users[]

string

Lista numerów telefonów użytkowników w formacie E.164.

Wszystkie numery telefonów w pojedynczej prośbie muszą należeć do tego samego regionu geograficznego. Żądania zawierające numery telefonów z wielu regionów lub wysłane do nieprawidłowego regionalnego punktu końcowego zakończą się niepowodzeniem i wygenerują błąd 400 Bad Request.
agentId

string

Wymagane. Unikalny identyfikator agenta.

Treść odpowiedzi

Odpowiedź z danymi o dostępności użytkownika w przypadku RCS dla firm.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Pola
reachableUsers[]

string

Lista numerów telefonów użytkowników, do których może dotrzeć RCS dla firm. Obejmuje tylko użytkowników korzystających z sieci operatorów, w których uruchomiono agenta.
totalRandomSampleUserCount

integer

Liczba numerów telefonów wybranych losowo z reachableUsers. Zwykle jest to około 75% łącznej liczby żądanych numerów telefonów. Jeśli liczba żądanych numerów telefonów jest mniejsza niż 500, ta wartość wynosi 0.
reachableRandomSampleUserCount

integer

Liczba numerów telefonów z losowo wybranej listy, które są dostępne w RCS we wszystkich sieciach, niezależnie od stanu wdrożenia agenta. Stosunek tej wartości do totalRandomSampleUserCount może przybliżać potencjalny zasięg listy użytkowników.
reachableUsersMap

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

Tylko dane wyjściowe. Mapa identyfikatora operatora na listę użytkowników, do których można dotrzeć za pomocą tego operatora. To pole jest wypełniane tylko w przypadku numerów telefonów w Stanach Zjednoczonych.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

ReachableUsers

Lista użytkowników, do których można dotrzeć w ramach konkretnego operatora.

Zapis JSON 
{
  "reachableUsers": [
    string
  ]
}
Pola
reachableUsers[]

string

Lista użytkowników, do których można dotrzeć w ramach konkretnego operatora. To pole jest wypełniane tylko w przypadku numerów telefonów w Stanach Zjednoczonych.