Справочник API

Подключение аккаунта

Переподключить runtime

Перестраивает соединение с провайдером, когда аккаунт онлайн, но runtime-соединение нестабильно.

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/runtime/reconnect

Поддерживаемые каналы

all

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

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

Проверьте текущие состояния авторизации и runtime, затем выберите действие по цели. Запуск, остановка, обновление и переподключение решают разные задачи; отсутствие подключения само по себе не означает необходимость новой авторизации.

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

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

Заголовки

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

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

Content-Type
stringобязательно

Используйте application/json при отправке JSON-тела запроса.

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

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

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

Тело запроса

Этот эндпоинт принимает пустой JSON-объект; отправьте {} как в примере запроса.

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

Прочитайте operation_status и runtime_status. При reconnecting проверьте состояние повторно и дождитесь running перед отправкой. При auth_required=true продолжите авторизацию канала.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "runtime_status": "reconnecting"
  }
}

Тело ответа

account_id
string

Аккаунт провайдера, к которому относится этот ответ.

provider
string

Идентификатор канала. Используйте значение API без изменений; возвращаемые этим API значения указаны в enum ниже.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

action
string

Действие, запрошенное этим вызовом.

enum: refresh_status, start, stop, reconnect

operation_status
string

Статус принятия или завершения действия runtime.

runtime_status
string

Нормализованное состояние runtime: одно из unknown, starting, running, stopping, stopped, reconnecting, disconnected или error.

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

runtime_error
string

Ошибка runtime провайдера, если действие не удалось завершить.

auth_required
boolean

При true продолжите авторизацию канала. Подсказка возвращается только при наличии данных авторизации от канала или ранее подтверждённого незавершённого процесса. Отсутствие поля или false не означает подключение: проверьте runtime_status. Одного disconnected недостаточно для вывода о необходимости повторной авторизации. Runtime API не возвращает code, qrcode, auth_payload или provider_data; получите данные через API авторизации канала.

auth_status
string

Необязательный статус авторизации: например pending, awaiting_qr_scan или passkey_required. Возвращается при наличии данных авторизации или подтверждённого незавершённого процесса. Следуйте руководству канала; полный статус и данные доступны в API авторизации, а состояние подключения — в runtime_status.

Ответы

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

502

Bad Gateway

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

При ошибке запроса

Проверьте HTTP-статус, error.code/numeric_code и текущее состояние; сохраните request_id. Уточните действие и поддержку канала. Продолжайте авторизацию при явной подсказке о её необходимости и проверьте состояние до повтора. Справочник ошибок

invalid_request · 10000 · 400
Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
missing_api_key · 11000 · 401
Проверьте X-Api-Key и активность рабочего пространства.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.
provider_not_ready · 30009 · 409
Проверьте HTTP-статус, error.code/numeric_code и текущее состояние; сохраните request_id. Уточните действие и поддержку канала. Продолжайте авторизацию при явной подсказке о её необходимости и проверьте состояние до повтора.