Альфа-имя SMS

Методы

GET Получить все доступные Альфа-имена —
GET Получить id Альфа-имени по его названию —
GET Получение категорий для Альфа-имени —
POST Создание нового Альфа-имени —
GET /api/v1/getAlphanames Получить все доступные Альфа-имена
URL запроса
GET https://app.sms.by/api/v1/getAlphanames

Параметры

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

Ответы

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

{
    "0": "Системное имя (SMS.by)",
    "1363": "VasheImya"
}

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

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

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

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

GET /api/v1/getAlphanameId Получить id Альфа-имени по его названию
URL запроса
GET https://app.sms.by/api/v1/getAlphanameId

Параметры

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

Ответы

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

{
    "id": 1236
}

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

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

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

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

GET /api/v1/getAlphanameCategory Получение категорий для Альфа-имени
URL запроса
GET https://app.sms.by/api/v1/getAlphanameCategory

Параметры

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

Ответы

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

{
    "status": "OK",
    "result": [
        {
            "id": 2,
            "name": "Авто (все,что касается автомобильной индустрии)"
        },
        {
            "id": 3,
            "name": "Банки\/займы"
        },
        {
            "id": 1,
            "name": "Выбрать"
        },
        {
            "id": 4,
            "name": "Гипермаркеты\/торговые сети\/торговые центры"
        },
        {
            "id": 5,
            "name": "Игры\/казино\/квесты"
        }
    ]
}

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

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

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

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

POST /api/v1/createAlphaname Создание нового Альфа-имени
URL запроса
POST https://app.sms.by/api/v1/createAlphaname

Параметры

Параметр Расположение Тип Обязательный Описание
token formData string Да Ваш API ключ
name formData string Да Название Альфа имени
yur_name formData string Да Юридическое лицо
unp formData integer Да Учетный номер плательщика
country_id formData integer Да Для РБ country_id = 1
postcode formData integer Да Индекс (Можно узнать на сайте белпочты)
city formData string Да Город регистрации
address formData string Да Юридический адрес (Если вы ИП, можно указать адрес проживания)
name_category_id formData integer Да Сфера деятельности компании ID (берется из метода getAlphanameCategory)
traffic_type_id formData integer Да Тип рассылки: 1 - Сервисная, 2 - Рекламная
text_example formData string Да Пример текста рассылки

Ответы

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

{
    "status": "ok",
    "message": "Альфа-имя MyCom успешно добавлено"
}

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

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

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

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