Справочник API

Авторизация аккаунта

Запустить аутентификацию по коду

Начните авторизацию с сохранённым номером. Для WhatsApp введите data.verify_code на телефоне; не отправляйте его в /auth/code. Для Telegram отправьте полученный код в /auth/code, а /auth/password вызывайте только при запросе дополнительного пароля. awaiting_code не означает успешную авторизацию.

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/auth/start

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

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

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

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

Заголовки

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

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

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

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

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

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

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

Тело запроса

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

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

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

Ответ 200 · WhatsApp

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "whatsapp",
    "action": "start_auth",
    "status": "awaiting_code",
    "auth_status": "awaiting_code",
    "verify_code": "ABCD-EFGH"
  }
}

Ответ 200 · Telegram

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "telegram",
    "action": "start_auth",
    "status": "awaiting_code",
    "auth_status": "awaiting_code",
    "auth_payload": {
      "type": "code"
    }
  }
}

Тело ответа

provider
string

Канал этой операции авторизации.

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

action
string

Запрошенная операция авторизации: start_auth.

enum: start_auth

status
string

Текущий статус авторизации. awaiting_code означает ожидание пользователя, authorized — завершение авторизации.

auth_status
string

Стандартный статус текущего шага, обычно совпадает с status.

verify_code
string

Код сопряжения WhatsApp по номеру телефона, непосредственно в data. Введите на телефоне; не отправляйте в /auth/code. Время истечения не гарантируется.

auth_payload
object

Подсказка авторизации для канала. Telegram может вернуть type=code; полученный пользователем код в ответ не включается.

type
string

Тип подсказки авторизации: code для шага ввода кода Telegram.

Ответы

200

200 · WhatsApp

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

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

500

Internal Server Error

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

502

Bad Gateway

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

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

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

invalid_request · 10000 · 400
Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.