Среда выполненияPOST

Обновить состояние runtime

Синхронизирует актуальное состояние runtime провайдера для аккаунта. runtime_status принимает одно из стандартных значений платформы: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error. Специфичные для провайдера метки предварительно нормализуются к этому набору.

https://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh

Заголовки

X-Api-Key

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

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

Content-Type

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

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

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

account_id

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

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

Тело запроса

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

Тело ответа

account_id

string

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

provider

string

Провайдер, runtime которого обработал действие.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol

action

string

Запрошенное действие runtime.

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 провайдера, если действие не удалось завершить.

Ответы

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

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

500

Internal Server Error

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

502

Bad Gateway

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

Запрос

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

Ответ

{
  "data": {
    "account_id": "acc_example",
    "runtime_status": "running"
  }
}