Справочник API

Groups

Заявки на вступление в группу

Список ожидающих заявок для группы с включённым одобрением вступления. group_id передаётся как query-параметр. Push-события из верхнего звена не гарантируются — опрашивайте этот эндпоинт как надёжный источник.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests

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

Используйте 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": {
    "group_id": "group_example",
    "items": [
      {
        "id": "member_example",
        "phone": "8613912345678",
        "requested_at": "2026-06-08T12:34:56Z"
      }
    ]
  }
}

Тело ответа

id
string

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

phone
string

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

lid
string

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

requested_at
string

Метка времени RFC3339 момента подачи заявки на вступление.

format: date-time

group_id
string

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

Ответы

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