Справочник API

Беседы

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

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

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

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

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

Откуда взять параметры
account_id
Возьмите data.id из создания или запроса аккаунта. Идентификатор относится к рабочему пространству X-Api-Key. Получить аккаунт
conversation_id
Беседа для поиска — значение, возвращаемое как conversation_id в List conversations.

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

Заголовки

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-тела запроса.

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

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

Ответ 200 OK

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

Тело ответа

conversation_id
string

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

type
string

Стандартный тип беседы: user, group или channel. Группы объявлений сообщества WhatsApp по-прежнему используют group.

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

Дополнительные поля провайдера. Групповые беседы WhatsApp могут содержать классификацию групп объявлений; список бесед не гарантирует наличие этой классификации.

is_announcement_group
boolean

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

Ответы

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 и активность рабочего пространства.