Отправка данных по SMS с помощью API

С помощью API можно взаимодействовать с AxelNAC для отправки SMS-сообщения пользователю-гостю.

предупреждение

Для создания интеграции с SMS-шлюзами пользователь должен иметь роль Администратор или обладать следующими правами: SMS_GATEWAY_READ, SMS_SEND_METHOD_AVAILABLE и System - Create.

Отправка учетных данных в SMS-сообщении

к сведению

Для отправки учетных данных в SMS-сообщении в SMS-шлюзе должен быть активирован параметр Отправка учетных данных.

Для того чтобы отправить пользователю-гостю SMS-сообщение с учетными данными, выполните следующие действия:

Шаг 1. Подключитесь с помощью любой системы автоматизации работы с API (Swagger, Postman и т.д.).

Шаг 2. Выберите тип запроса POST и укажите в поле запроса https://<IP-адрес_AxelNAC>:9999/api/v1/sms_gateways/send_user_credentials.

Шаг 3. Выберите тип авторизации Bearer Token и введите токен авторизации.

Шаг 4. В тело запроса добавьте следующую информацию в формате raw:

    {
    "sms_gateway":"Используемый_SMS-шлюз",
    "pid":"Имя_пользователя-гостя_в_AxelNAC",
    "password":"Пароль_для_пользователя-гостя"
    }

внимание

Для корректной отправки учетных данных, в профиле пользователя должен быть указан его номер телефона.

Шаг 4. Выполните запрос.

После выполнения запроса пользователю-гостю будут отправлены учетные данные для доступа к сети в SMS-сообщении на номер, который был указан при создании.

Отправка информационных сообщений

к сведению

Для отправки учетных данных в SMS-сообщении в SMS-шлюзе должен быть активирован параметр Отправка учетных данных.

Для того чтобы отправить пользователю SMS-сообщение с какой-либо информацией, выполните следующие действия:

Шаг 1. Подключитесь с помощью любой системы автоматизации работы с API (Swagger, Postman и т.д.).

Шаг 2. Выберите тип запроса POST и укажите в поле запроса https://<IP-адрес_AxelNAC>:9999/api/v1/sms_gateways/send_sms.

Шаг 3. Выберите тип авторизации Bearer Token и введите токен авторизации.

Шаг 4. В тело запроса добавьте следующую информацию в формате raw:

    {
    "sms_gateway":"Используемый_SMS-шлюз",
    "phone_number":"Номер_телефона_на_который_будет_отправлено_сообщение",
    "message":"Тело_сообщения"
    }

Шаг 4. Выполните запрос.

После выполнения запроса пользователю будет отправлено SMS-сообщение на номер, который был указан при регистрации.