Вы можете бесплатно подключиться к нашему смс-шлюзу, активация услуги не требуется. СМС-шлюз позволяет автоматизировать рассылку 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
Одиночная   pdf  
Массовая
Баланс
Статусы
Альфа-имена
TOP