API Docs Help

Send sms

Метод

Путь

Описание

POST

/sms

Отправка сообщения пользователю.

Request body
*Required

{ "AUTH": "test", "provider": "pname", "recipient_numbers": [ "+375299988777" ], "message_text": "Test text" }

Request body schema

Тип

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

Описание

AUTH

string

test

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

provider

string

pname

Наименование провайдера, через которого идет отправка сообщения.

recipient_numbers

array

375299988777

Массив телефонных номеров получателей сообщения.
Формат: международный.

message_text

string

Test text

Текст сообщения.

Request URL

http://<mapi.services>/sms

Example request:

curl -X 'POST' \ 'http://<mapi.services>/sms' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "AUTH": "test", "provider": "pname", "recipient_numbers": [ "+375299988777" ], "message_text": "Test text" }'

Responses:

200 Successful operation

Сообщение отправлено получателю.

Controls Accept header. Media type application/json

Example response:

{ "success": true, "message": "SMS sent" }

Response schema

Тип

Описание

Пример

success

boolean

Указывает на успешность операции.
true или false.

true

message

string

Текстовое сообщение с дополнительной информацией о результате операции.

SMS sent

422 Error: Unprocessable Entity

Сервер понимает содержимое запроса, но не может его обработать из-за проблем с валидацией данных.

Media Type: text/plain

Example response:

Wrong provider

Response schema

Тип

Описание

message

string

Описание ошибки.
"Wrong provider" - указанный провайдер недоступен или неверен.

503 Error: Service Unavailable

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

Media Type: text/plain

Example response:

No auth

Response schema

Тип

Описание

message

string

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

29 September 2025