Method: users.batchGet

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

Возвращаемая полезная нагрузка содержит список телефонных номеров с поддержкой RCS, доступных платформе RCS для бизнеса для указанных пользователей. Будут возвращены только номера телефонов с поддержкой 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

Обязательно. Уникальный идентификатор агента.

Тело ответа

Ответ с данными о достижимости пользователей для RCS for Business.

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

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

string

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

totalRandomSampleUserCount

integer

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

reachableRandomSampleUserCount

integer

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

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

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

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

Для получения более подробной информации см.OAuth 2.0 Overview .