Method: users.batchGet

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

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

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

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

Важно: метод users.batchGet требует использования региональных конечных точек. Запросы должны содержать номера телефонов из одного географического региона. Отправка номеров телефонов из нескольких регионов в одном запросе или отправка запроса на неправильную региональную конечную точку приведет к ошибке 400 Bad Request .

Региональные конечные точки:

HTTP-запрос

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

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

Текст запроса

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

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

string

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

Все телефонные номера в одном запросе должны относиться к одному географическому региону. Запросы, содержащие телефонные номера из нескольких регионов или отправленные на неправильный региональный адрес, завершатся ошибкой 400 Bad Request .

agentId

string

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

Ответный текст

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

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

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

string

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

totalRandomSampleUserCount

integer

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

reachableRandomSampleUserCount

integer

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

reachableUsersMap

map (key: string, value: object ( ReachableUsers ))

Только для вывода. Сопоставление идентификатора оператора связи со списком доступных пользователей у этого оператора. Это поле заполняется только для телефонных номеров США.

Области полномочий

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

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

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

ДоступныеПользователи

Список доступных пользователей у конкретного оператора связи.

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

string

Список доступных пользователей у конкретного оператора связи. Это поле заполняется только для телефонных номеров США.