Формат запиту JSON API

Усі запити до API надсилаються у форматі JSON за допомогою методу POST.

У запитах обов'язково має бути заголовок Content-Type: application/json, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.

Специфікація OpenAPI

Машиночитаний опис цього API опубліковано поруч із документацією:

• openapi.yaml
• openapi.json

Файл імпортується в Postman, Insomnia або генератор клієнта. Він описує JSON-транспорт із цих сторінок: конверт запиту, кожну задокументовану операцію за data[].type, формат відповіді та вебхук зі статусом доставки.

Базовий URL

Базовий URL для синхронних API запитів: https://alphasms.ua

Для асинхронної відправки: https://api-async.alphasms.ua

Авторизація

Кожен запит повинен містити рядок auth з вашим API-ключем, отриманим з вашого особистого кабінету як доповнення до основних параметрів методу:

Параметри запиту

authstringобов'язковий Ваш API-ключ, який можна отримати в особистому кабінеті

Приклад запиту

{
    "auth": "bb56a4369eb19***cfec6d1776bd25"
}

Формат запиту

Всі параметри запиту передаються як об'єкти всередині масиву data. Набір параметрів запиту залежить від вказаного типу запиту (докладніше в описі методів API).

Наприклад, масив data може містити декілька об'єктів з параметрами запиту:

Параметри запиту

authstringобов'язковий Ваш API-ключ, який можна отримати в особистому кабінеті

datalist[object]обов'язковий Список об'єктів з параметрами запиту MESSAGE 1object Параметри повідомлення MESSAGE 2object Параметри повідомлення MESSAGE 3object Параметри повідомлення

Приклад запиту

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            MESSAGE 1
        },
        {
            MESSAGE 2
        },
        {
            MESSAGE 3
        }
    ]
}