Method: users.batchGet

Получает номера телефонов с поддержкой RCS для списка пользователей.

Возвращенные полезные данные содержат список телефонных номеров с поддержкой RCS, доступных платформе RBM для указанных пользователей. Будут возвращены только номера телефонов с поддержкой RCS для оператора связи, на котором запущен агент.

Возвращенные полезные данные также содержат значения, которые можно использовать для оценки потенциального охвата списка телефонных номеров независимо от статуса запуска агента.

Максимум 600 запросов в минуту (QPM).

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "users": [
    string
  ],
  "agentId": string
}
Поля
users[]

string

Список телефонных номеров пользователей в формате E.164.

agentId

string

Необходимый. Уникальный идентификатор агента.

Тело ответа

Ответ с пользовательскими данными о доступности RBM.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Поля
reachableUsers[]

string

Список телефонных номеров пользователей, с которыми может связаться RBM. Включает только пользователей операторов связи, на которых запущен агент.

totalRandomSampleUserCount

integer

Количество телефонных номеров, случайно выбранных из reachableUsers . Обычно это значение составляет ~75% от общего количества запрошенных телефонных номеров. Это значение равно 0 , если количество запрошенных телефонных номеров меньше 500.

reachableRandomSampleUserCount

integer

Количество телефонных номеров из случайно выбранного списка, доступных по RCS для всех операторов связи, независимо от статуса запуска агента. Соотношение между этим значением и totalRandomSampleUserCount может приблизительно оценить потенциальный охват списка пользователей.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .