Send sms
Метод | Путь | Описание |
|---|---|---|
POST | /sms | Отправка сообщения пользователю. |
Request body
*Required
Request body schema | Тип | Пример значения | Описание |
|---|---|---|---|
AUTH | string |
| Токен аутентификации/ключ, необходимый для доступа к API. |
provider | string |
| Наименование провайдера, через которого идет отправка сообщения. |
recipient_numbers | array |
| Массив телефонных номеров получателей сообщения. |
message_text | string |
| Текст сообщения. |
Request URL |
|---|
|
Example request:
Responses:
200 Successful operation
Сообщение отправлено получателю.
Controls Accept header. Media type |
|---|
Example response:
Response schema | Тип | Описание | Пример |
|---|---|---|---|
success | boolean | Указывает на успешность операции. | true |
message | string | Текстовое сообщение с дополнительной информацией о результате операции. | SMS sent |
422 Error: Unprocessable Entity
Сервер понимает содержимое запроса, но не может его обработать из-за проблем с валидацией данных.
Media Type: |
|---|
Example response:
Response schema | Тип | Описание |
|---|---|---|
message | string | Описание ошибки. |
503 Error: Service Unavailable
Ошибка сервиса. Сервер временно недоступен для обработки запроса.
Media Type: |
|---|
Example response:
Response schema | Тип | Описание |
|---|---|---|
message | string | Описание ошибки. |