Навігація

Ви можете безкоштовно підключитися до нашого смс-шлюзу, активація послуги не потрібна. СМС-шлюз дозволяє автоматизувати розсилку sms повідомлень і вбудувати сервіс в будь-який проект.

Всі дані, які передаються в API повинні бути в кодуванні UTF-8.

JSON API (рекомендований метод)

Спілкування з сервісом здійснюється за допомогою відправки HTTP-запитів, методом POST, на задану адресу використовуючи текстовий формат обміну даними «JSON».

Для автентифікації запиту використовується «OAuth 2». При даному типі автентифікації необхідно використовувати token, який можно отримати в особистому кабінеті у розділі «Профіль». Після чего відповідно увімкнути даний токен у заголовок запиту, наприклад як: 'Authorization: Bearer your_token'.

Увага!

Обмеження частоти запитів к сервісу, повино бути не більше 9 запитів в секунду від одного клієнта.

Відправка повідомлення

    Адреса служби:
  • https://im.smsclub.mobi/sms/send

Відправка повідомлення відбувається за допомогою задання нижчеописаних параметрів.

  • src_addr – Альфа-им'я, від якого йде відправка;
  • phone – Масив номерів, можно выдправляти до 100 номерів за запит;
  • message – Текст повідомлення;
  • integration_id – Не обов'язкове поле. Заповнювати при використанні реферальної системи;

Приклад відправки повідомлення в «JSON» форматі:

{
    "phone" : ["380989361131"],
    "message" : "test text",
    "src_addr" : "VashZakaz"
}

Після успішної відправки повідомлення система поверне масив «info» в якому ключ це id повідомлення у нашій системі, за яким можно отримати статус, а значенням буде номер телефону на який відправлено повідомлення. У прикладі нижче «106» - id sms, 380989361131 — номер отримувача.

Приклад відповіді у «JSON» форматі:

{
 "success_request": {
    "info": {
        "106": "380989361131"
    }
 }
}

Отримання статусу повідомлення

    Адреса служби:
  • https://im.smsclub.mobi/sms/status

Для отримання статусу повідомлення необхідно передати єдиний параметр:

  • id_sms – Масив з ID повідомлень по яким необхідно отримати статус, ліміт не більше 100;

Прикоад в «JSON» форматі:

{
    "id_sms": ["106"]
}

Після успішного запиту система поверне масив «info», в якому ключ буде id повідомлення, а значенням його статус. 

{
 "success_request": {
    "info": {
        "106": "ENROUTE"
        }
    }
}

Статуси:

  • 200 – Запит успішно оброблений.

    • Можливі статусі повідомлень:

    • ENROUTE – повідомлення відправлено;
    • DELIVRD – повідомлення доставлено;
    • EXPIRED – закінчився термін життя, повідомлення не доставлено;
    • UNDELIV – неможливо доставити повідомлення;
    • REJECTD – повідомлення відхилено системою (чорний список або інші фільтри).
  • 400 – Помилка валідаціх вхідних параметрів.
  • 401 – Помилка автентифікації користувача.
  • 429 – Занадто багато запитів на одиницю часу. За замовчуванням необхідно виконувати не більше ніж 9 запитів за 1 секунду.
  • 453 – Дублювання повідомлення в інтервалі менше ніж 2 хвилини.
  • 500х – Сервіс тимчасово недоступний.

Отримання списку альфа-імен

    Адреса служби:
  • https://im.smsclub.mobi/sms/originator

Для отримання списку доступних альфа-імен, необхідно провести запит на вище вказанний URL без тіла запиту використовуючи лише авторизовану інформацію користувача.

Після успішного запиту система поверне список активних альфа-імен:

Приклад відповіді:

{
 "success_request": {
    "info": [
        "test1",
        "test2"
        ]
    }
}

Отримання балансу користувача

    Адреса служби:
  • https://im.smsclub.mobi/sms/balance

Для отримання балансу,необхідно провести запит на вище вказаний URL без тіла запиту, використовуючи лише авторизовану інформацію користувача.

Після успішного запиту система поверне баланс користувача, масив «info» де:

  • money - баланс
  • currency - валюта акаунта

Приклад відповіді:

{
 "success_request": {
    "info": {
        "money": "8111.1700",
        "currency": "UAH"
        }
    }
}

SMPP-шлюз

Даний шлюз відповідає всім параметрам протоколу SMPP v3.4. Для тестування нашого шлюзу необхідно зв'язатися з адміністрацією.


HTTP-шлюз

Даний шлюз дає можливість відправляти HTTP запити на задану адресу сервісу по протоколу HTTP методами GET/POST. Для тестування нашого шлюзу необхідно зв'язатися з адміністрацією.


XML-шлюз

Даний шлюз дає можливість відправляти XML запити в кодуванні UTF-8 на задану адресу сервісу по протоколу HTTP методом POST. Для тестування нашого шлюзу необхідно зв'язатися з адміністрацією.


Завантажити приклади

Тут Ви можете скачати приклади скриптів для роботи з обраним шлюзом:

Метод JSON 1С
Поодинока    
Масова
Баланс
Статуси
Альфа-імена
TOP