API Docs Help

Getting sms provider list

Метод

Путь

Описание

POST

/sms-providers-list

Получение списка SMS-провайдеров.

Request body
*Required

{ "AUTH": "test" }

Request body schema

Тип

Пример значения

Описание

AUTH

string

test

Токен аутентификации/ключ, необходимый для доступа к API.

Request URL:

http://<mapi.services>/sms-providers-list

Example request:

curl -X 'POST' \ 'http://<mapi.services>/sms-providers-list' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "AUTH": "test" }'

Responses:

200 Successful operation

Список SMS провайдеров получен.

Controls Accept header. Media type application/json

Example response:

{ "status": "success", "info": [ { "id": 1, "name": "PName", "type": "sms", "code": "pname", "info": "{\"api_key\":{\"name\":\"API key\",\"position\":1,\"description\":\"Your API key\"}}", "is_active": 1 } ] }

Response schema

Тип

Описание

Пример

success

string

Статус выполнения запроса.
succes или error.

success

info

array

Массив объектов, содержит информацию о SMS-провайдерах.

└─ id

integer

Уникальный идентификатор SMS-провайдера.

1

└─ name

string

Наименование SMS-провайдера.

PName

└─ type

string

Тип провайдера.

sms

└─ code

string

Код SMS-провайдера.

name

└─ info

string

Дополнительная информация о провайдере в формате JSON: JSON-кодированная строка с дополнительными деталями о ключе API провайдера.
api_key - объект, содержит детали о ключе API,
name (строка): название ключа,
position (целое число): позиция ключа в конфигурации,
description (строка): описание назначения ключа.

{\"api_key\":
{\"name\":\"API key\",
\"position\":1,
\"description\":\"Your API key\"}}

└─ is_active

string/null

Статус активности провайдера
(1 - активен, 0 - неактивен).

1

503 Error: Service Unavailable

Ошибка сервиса. Сервер временно недоступен для обработки запроса.

Media Type: text/plain

Example response:

No auth

Response schema

Тип

Описание

message

string

Описание ошибки.
"No auth" указывает на то, что отсутствуют необходимые учетные данные для выполнения запроса.

29 September 2025