Templates

Методы

POST Получить все шаблоны сообщений —
POST Получить шаблон сообщения по ID —
POST Создание шаблона сообщения —
POST Измениеие шаблона сообщения —
POST Удаление шаблона сообщения —
POST /api/v2/getTemplateMessages Получить все шаблоны сообщений
URL запроса
POST https://app.sms.by/api/v2/getTemplateMessages

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": [
        {
            "id": 11,
            "name": "Название шаблона"
        },
        {
            "id": 12,
            "name": "Название второго шаблона"
        }
    ]
}
POST /api/v2/getTemplateMessageById Получить шаблон сообщения по ID
URL запроса
POST https://app.sms.by/api/v2/getTemplateMessageById

Параметры

Параметр Расположение Тип Обязательный Описание
token query string Да Ваш API ключ
template_id query string Да Ваш ID шаблона сообщения

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "id": 12,
        "name": "Название шаблона",
        "message": "Текст сообщения",
        "parts": 1
    }
}
POST /api/v2/createTemplateMessage Создание шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/createTemplateMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Название шаблона
message formData string Да Текст шаблона

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "Название нового шаблона",
        "message": "Текст нового сообщения",
        "parts": 1
    }
}
POST /api/v2/editTemplateMessage Измениеие шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/editTemplateMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
template_id formData integer Да ID шаблона
name formData string Да Название шаблона
message formData string Да Текст шаблона

Ответы

200 — Выполнено успешно

{
    "status": "OK",
    "result": {
        "id": 16,
        "name": "Новое название шаблона",
        "message": "Новый текст сообщения",
        "parts": 1
    }
}
POST /api/v2/deleteTemplateMessage Удаление шаблона сообщения
URL запроса
POST https://app.sms.by/api/v2/deleteTemplateMessage

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
template_id formData integer Да ID шаблона

Ответы

200 — Выполнено успешно

{
    "status": "OK"
}