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 z wsparciem RCS, do których może dotrzeć platforma RBM w przypadku określonych użytkowników. Zwrócone zostaną tylko numery telefonów, które obsługują RCS w przypadku operatora, w którego przypadku 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 uruchomienia agenta.

Maksymalnie 600 zapytań na minutę.

Żą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 dostępności 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, do których może docierać RBM. Obejmuje tylko użytkowników korzystających z usług operatorów, na których działa agent.
totalRandomSampleUserCount

integer

Liczba numerów telefonów wybranych losowo z reachableUsers. Zwykle jest to około 75% łącznej liczby żądanych numerów telefonów. Ta wartość to 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 można osiągnąć za pomocą RCS u wszystkich operatorów niezależnie od stanu uruchomienia usługi. Stosunek tej wartości do wartości totalRandomSampleUserCount może być przybliżeniem potencjalnego zasięgu 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 OAuth 2.0.