← Справочник API
АккаунтыPOST

Создать аккаунт

Создаёт аккаунт провайдера. Поддерживаются telegram, whatsapp, twitter, line, zalo. Используйте auth_mode = code, qrcode или session в зависимости от потока. Когда выбранная комбинация provider + auth_mode требует номера телефона (например, WhatsApp с auth_mode=code), номер необходимо указать здесь через provider_data.phone — он сохраняется в аккаунте и автоматически переиспользуется при последующих действиях аутентификации.

https://api.unifyport.ai/v1/accounts

Заголовки

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

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

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

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

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

У этого эндпоинта нет параметров пути.

Тело запроса

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

Понятное человеку имя аккаунта.

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

Идентификатор провайдера, например telegram, whatsapp, line или zalo.

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

Регион провайдера, используемый для выделения. Выберите регион со значением allocatable: true из Список регионов провайдера.

auth_mode
string

Поток аутентификации: code, qrcode или session.

provider_data
object

Конфигурация провайдера. Не выводите секреты в логи.

metadata
object

Метаданные платформы для меток окружения.

Тело ответа

id
string

Уникальный идентификатор аккаунта (acc_...). Используйте его в маршрутах уровня аккаунта.

name
string

Понятное человеку имя аккаунта.

provider
string

Идентификатор провайдера, например telegram, whatsapp, line, twitter или zalo.

region
string

Регион провайдера, в котором выделен аккаунт.

status
string

Состояние жизненного цикла аккаунта, например active.

runtime_status
string

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

auth_mode
string

Поток аутентификации, используемый аккаунтом: code, qrcode или session.

capabilities
string[]

Возможности, включённые для аккаунта, например send_message и receive_message.

provider_account_ref
string

Идентификатор на стороне провайдера, который можно привязать для сопоставления аккаунта с вашей собственной системой.

Ответы

201
201 Created

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

400
Bad Request

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

401
Unauthorized

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

409
Conflict

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

500
Internal Server Error

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

Запрос

curl -X POST https://api.unifyport.ai/v1/accounts \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Telegram Production",
  "provider": "telegram",
  "region": "global",
  "status": "active",
  "auth_mode": "qrcode",
  "capabilities": ["send_message", "receive_message"],
  "provider_data": {},
  "metadata": {
    "env": "production"
  },
  "provider_account_ref": "provider-side-identifier"
}'

Ответ

{
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "region": "global",
    "status": "active",
    "runtime_status": "stopped",
    "auth_mode": "qrcode",
    "capabilities": ["send_message", "receive_message"],
    "provider_account_ref": "provider-side-identifier"
  }
}