БеседыGET

Детали беседы

Возвращает одну беседу в реальном времени. conversation_id передаётся как query-параметр (значение из List conversations). Ответ всегда содержит conversation_id / type / title / avatar_url (пустая строка при отсутствии), а также специфичные для типа поля, например members_count для групп; возвращает 404, если беседа не найдена.

https://api.unifyport.ai/v1/accounts/{account_id}/conversations/info

Заголовки

X-Api-Key

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

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

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

account_id

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

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

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

conversation_id

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

Беседа для поиска — значение, возвращаемое как conversation_id в List conversations.

type

string

Тип беседы (user, group или channel) для устранения неоднозначности при поиске.

enum: user, group, channel

Тело запроса

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

Тело ответа

conversation_id

string

Идентификатор беседы. Используйте его как цель при отправке сообщений или вызове маршрутов бесед.

type

string

Тип беседы: user, group или channel.

enum: user, group, channel

title

string

Отображаемое название беседы.

username

string

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

avatar_url

string

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

description

string

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

last_message_at

string

Метка времени RFC3339 самого последнего сообщения.

format: date-time

last_message_text

string

Текстовый фрагмент последнего сообщения, если доступен.

unread_count

integer

Число непрочитанных сообщений в беседе.

format: int64

members_count

integer

Число участников; возвращается для групповых бесед.

format: int64

subscribers_count

integer

Число подписчиков канала, если доступно.

format: int64

is_pinned

boolean

Закреплена ли беседа подключённым аккаунтом.

is_muted

boolean

Отключены ли уведомления беседы для подключённого аккаунта.

created_at

string

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

format: date-time

extra

object

Поля провайдера, не представленные стандартной схемой.

Ответы

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

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

Запрос

curl -X GET https://api.unifyport.ai/v1/accounts/{account_id}/conversations/info?conversation_id=peer_example&type=group \
  -H "X-Api-Key: <YOUR_API_KEY>"

Ответ

{
  "data": {
    "conversation_id": "peer_example",
    "type": "group",
    "title": "Group title",
    "avatar_url": "",
    "description": "...",
    "unread_count": 0,
    "members_count": 42
  }
}