Method: users.batchGet

Pobiera numery telefonów z włączoną usł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 Business Messaging 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).

Żą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 o dostępności użytkownika w przypadku RCS Business Messaging.

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, 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.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.