Счета

Методы

GET Получить все созданные счета —
POST Создание счета —
GET Скачать счет —
GET /api/v1/getBills Получить все созданные счета
URL запроса
GET https://app.sms.by/api/v1/getBills

Параметры

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

Ответы

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

{
    "status": "success",
    "data": {
        "total": 160,
        "per_page": 15,
        "current_page": 1,
        "last_page": 11,
        "next_page_url": "https:\/\/app.sms.by\/api\/v1\/getBills?page=1",
        "prev_page_url": null,
        "from": 1,
        "to": 15,
        "data": [
            {
                "id": 1449,
                "user_id": 2,
                "d_create": "1526034626",
                "d_payment": 0,
                "amount": "120.00",
                "manager_id": 0,
                "comment": "Пополнение счета на 120 рублей",
                "info": "0",
                "type": "SMS",
                "rent": "0",
                "number": "C11449\/20180511"
            }
        ]
    }
}

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен

POST /api/v1/createBill Создание счета
URL запроса
POST https://app.sms.by/api/v1/createBill

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
amount formData integer Да Сумма пополненния баланса
amount_type formData string Да Тип баланса. Может быть sms или viber
type formData string Нет Тип пополнения баланса (для Viber баланса обязательно). Может быть 'subscription' или 'replenishment'

Ответы

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

{
    "status": "success",
    "data": {
        "user_id": 2,
        "amount": "500",
        "d_create": "1616510192",
        "d_payment": 0,
        "manager_id": 0,
        "info": 0,
        "type": "sms",
        "rent": 0,
        "comment": "Пополнение SMS счета на 500 руб.",
        "id": 3294,
        "number": "C13294\/20210323"
    }
}

400 — Некорректный запрос

421 — Данные прошли проветку

429 — Превышен лимит запросов

500 — Сервер недоступен

GET /api/v1/downloadBill Скачать счет
URL запроса
GET https://app.sms.by/api/v1/downloadBill

Параметры

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

Ответы

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

400 — Некорректный запрос

404 — Страница не найдена

429 — Превышен лимит запросов

500 — Сервер недоступен