Method: users.batchGet

Pobiera numery telefonów obsługujące RCS dla listy użytkowników.

Zwrócony ładunek zawiera listę numerów telefonów obsługujących RCS, dostępnych dla platformy RBM dla określonych użytkowników. Zwrócone zostaną tylko numery telefonów, które obsługują RCS u operatora, u którego uruchomiono agenta.

Zwrócony ładunek zawiera też wartości, które mogą sł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

To pole jest wymagane. Unikalny identyfikator agenta.

Treść odpowiedzi

Odpowiedź z danymi użytkownika w 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 może się skontaktować RBM. Obejmuje tylko użytkowników korzystających z usług operatorów, u których został uruchomiony agent.
totalRandomSampleUserCount

integer

Liczba losowo wybranych numerów telefonów z grupy reachableUsers. Zazwyczaj ta wartość stanowi ok. 75% łącznej liczby żądanych numerów telefonów. Ta wartość wynosi 0, jeśli liczba żądanych numerów telefonów jest mniejsza niż 500.
reachableRandomSampleUserCount

integer

Liczba numerów telefonów z losowo wybranej listy, które są dostępne w ramach RCS u wszystkich operatorów, niezależnie od stanu uruchomienia agenta. Stosunek tej wartości do totalRandomSampleUserCount może oszacować 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 artykule Omówienie protokołu OAuth 2.0.