Справочник API

Беседы

Список бесед

Возвращает беседы в реальном времени. limit: 1..100, по умолчанию 20. type содержит точные значения user / group / channel без trim. В WhatsApp без label_id возвращаются избранные / «特别关注» беседы. Невалидный cursor обрабатывается провайдерами по-разному.

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

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

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

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

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

Заголовки

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

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

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

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

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

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

type
string

Точные значения user, group и channel через запятую; пробелы не обрезаются.

cursor
string

Непрозрачный next_cursor. Пропустите для первой страницы; невалидные или устаревшие курсоры обрабатываются провайдерами по-разному.

limit
integer

Размер страницы от 1 до 100; значение по умолчанию указано на странице эндпоинта.

minimum: 1 · maximum: 100

label_id
string

Точный ID метки. В WhatsApp без label_id возвращаются избранные / «特别关注» беседы.

Тело запроса

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

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

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

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "conversation_id": "peer_example",
        "type": "user",
        "title": "Display name",
        "avatar_url": "",
        "unread_count": 3,
        "last_message_at": "2026-05-13T10:00:00Z"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

Тело ответа

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

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

next_cursor
string

Непрозрачный курсор для следующей страницы. Передайте его обратно как cursor; пустая строка означает, что больше страниц нет.

has_more
boolean

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

Ответы

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

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