Справочник API

Беседы

Список участников

Возвращает участников беседы типа group. conversation_id передаётся в query; пагинация — через cursor / limit. Каждый элемент содержит peer_id / display_name / avatar_url, а role принимает member / admin / superadmin; superadmin — владелец или создатель группы. Для неподдерживаемого типа беседы, например 1:1, возвращается 400.

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

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

Используйте 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

cursor
string

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

limit
integer

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

minimum: 1 · maximum: 100

Тело запроса

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

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

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

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "peer_id": "user_example",
        "display_name": "",
        "avatar_url": "",
        "role": "superadmin"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

Тело ответа

peer_id
string

Непрозрачный идентификатор участника внутри беседы. WhatsApp обычно возвращает LID; номер телефона, если доступен, находится отдельно в extra.phone.

username
string

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

display_name
string

Отображаемое имя участника или пустая строка, если оно отсутствует.

avatar_url
string

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

role
string

Нормализованная роль: владелец/создатель — superadmin, администратор — admin, обычная или неизвестная — member.

enum: member, admin, superadmin

joined_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 отсутствует или недействителен.

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