Справочник API

Groups

Get group

Returns one group in real time. Pass group_id as a query parameter (it can contain @ / : so it is not placed in the path). Returns 404 when the group cannot be found.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/info

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Откуда взять параметры
account_id
Возьмите data.id из создания или запроса аккаунта. Идентификатор относится к рабочему пространству X-Api-Key. Получить аккаунт
group_id
Группа для действия — id, возвращаемый в List groups. Передаётся в строке запроса, поскольку id провайдера могут содержать @ или :.

Параметры запроса

Заголовки

X-Api-Key
stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Параметры пути

account_id
stringобязательно

Идентификатор для маршрута раздела groups.

Параметры запроса

group_id
stringобязательно

Группа для действия — id, возвращаемый в List groups. Передаётся в строке запроса, поскольку id провайдера могут содержать @ или :.

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Как понять результат

Следуйте описанию полей и HTTP-статуса. Успешный 204 не содержит тела; для диагностики используйте X-Request-Id. Следующий шаг указан в связанных операциях.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "group_example",
    "conversation_id": "group_example",
    "name": "Project team",
    "avatar_url": "",
    "member_count": 5,
    "description": "..."
  }
}

Тело ответа

id
string

Идентификатор группы. Для группы conversation_id равен этому id.

conversation_id
string

Идентификатор беседы для группы; равен id.

name
string

Название группы.

avatar_url
string

URL аватара группы или пустая строка, если он не задан.

member_count
integer

Число участников в группе.

format: int64

joined_at
string

Время вступления подключённого аккаунта в группу, если доступно.

format: date-time

created_at
string

Время создания группы по данным провайдера, если доступно.

format: date-time

description
string

Описание группы, когда оно доступно.

permissions
object

Group-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.

admins_only
boolean

true means only administrators may speak; false is an explicit state, not an omitted or default value.

extra
object

Дополнительные поля групп, зависящие от провайдера. Данные групп WhatsApp могут содержать классификацию групп объявлений в зависимости от доступных при текущем запросе данных.

is_announcement_group
boolean

Предоставляется только для групп WhatsApp. true подтверждает, что это группа объявлений сообщества; false означает, что текущие данные подтверждают несоответствие условиям такой группы. Отсутствие поля означает неизвестное состояние; null не возвращается. Эта классификация не указывает на право текущего аккаунта отправлять сообщения. Не зависит от permissions.admins_only.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

400

Bad Request

Тело запроса, путь или параметры некорректны.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

404

Not Found

Запрошенный ресурс провайдера не найден.

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

501

Not Implemented

Выбранный провайдер не реализует эту операцию.

502

Bad Gateway

Адаптер или вышестоящий провайдер не смог завершить операцию.

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

invalid_request · 10000 · 400
Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.