Провайдеры

Список регионов провайдера

Возвращает регионы, в которых развёрнут провайдер. supported показывает, работает ли провайдер в регионе вообще; allocatable показывает, можно ли в данный момент привязывать новые аккаунты к этому региону.

GEThttps://api.unifyport.ai/v1/providers/{provider}/regions

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

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

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

Заголовки

X-Api-Key

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

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

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

provider

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

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

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, x, x_client, twitter_client

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

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

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

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}

Тело ответа

provider

string

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

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

regions[]

object[]

Список регионов; каждый элемент содержит флаги supported и allocatable.

region

string

Идентификатор региона размещения провайдера.

supported

boolean

Работает ли провайдер в этом регионе.

allocatable

boolean

Можно ли сейчас размещать новые аккаунты в этом регионе.

Ответы

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

500

Internal Server Error

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

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

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

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