Method: users.batchGet

Pobiera numery telefonów obsługiwane przez RCS w przypadku listy użytkowników.

Zwracany ładunek zawiera listę numerów telefonów obsługiwanych przez RCS, które platforma RBM ma dostęp do danych określonych użytkowników. Zwrócone zostaną tylko te numery telefonów z obsługą RCS u operatora, u którego działa agent.

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

Maksymalnie 600 zapytań na minutę (QPM).

Żą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.
agentId

string

Wymagane. Unikalny identyfikator agenta.

Treść odpowiedzi

Odpowiedź z danymi użytkownika dotyczącymi zasięgu RBM.

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

Zapis JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Pola
reachableUsers[]

string

Lista numerów telefonów użytkowników, z którymi RBM może się skontaktować. Obejmuje tylko użytkowników u tych operatorów, u których został uruchomiony agent.
totalRandomSampleUserCount

integer

Liczba numerów telefonów wybranych losowo z: reachableUsers. Zwykle ta wartość stanowi ok. 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 przez RCS u wszystkich operatorów bez względu na stan uruchamiania agenta. Stosunek tej wartości do wartości totalRandomSampleUserCount może przybliżyć potencjalny zasięg dla listy użytkowników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.