API интеграция SMS

СМС-шлюз позволяет автоматизировать рассылку sms сообщений и встроить сервис в любой проект

Попробовать бесплатно

Вы можете бесплатно подключиться к нашему смс-шлюзу, активация услуги не требуется. Все данные, которые передаются в API должны быть в кодировке UTF-8.

Отправка сообщений API

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

Отправка сообщений осуществляется посредством задания нижеописанных параметров:

1.

src_addr

*
Альфа-имя, от которого
идет отправка
2.

phone

*
Массив номеров
(до 100 за запрос)
3.

message

*
Текст сообщения
4.

integration_id

*необязательное поле
*Заполнять при использовании реферальной системы

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

Пример отправки сообщения в «JSON» формате:

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

Пример ответа в «JSON» формате:

{
 "success_request": {
    "info": {
        "106": "380989361131"
    }
 }
}
                
Тарифы

Получение статуса сообщений

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

Для получения статусов сообщений необходимо передать единственный параметр: id_sms – Массив из ID сообщений по которым нужно получить статус, лимит не более 100. После успешного запроса системе вернет массив «info», в котором ключ будет id сообщения, а значением его статус.

Запрос на получение статуса:

{
    "id_sms" : ["106"],
}
                

Пример ответа в:

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

Статусы

200 – Запрос успешно обработан. Возможные статусы сообщений:

1.

ENROUTE

сообщение отправлено
2.

DELIVRD

сообщение доставлено
3.

EXPIRED

истек срок жизни, сообщение не доставлено
4.

UNDELIV

невозможно доставить сообщение
5.

REJECTD

сообщение отклонено системой

Ошибки

400

Ошибка валидации входных параметров

401

Ошибка аутентификации пользователя

429

Слишком много запросов на единицу времени

453

Дублирование сообщения в интервале меньше чем 2 минуты

500x

Сервис временно недоступен

Получение списка альфа-имен пользователей

Адрес службы: 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-шлюз

ESME

SMSC

MSC

SMS, EMS, WAP, USSD, ets

Данный шлюз отвечает всем параметрам протокола SMPP v3.4. Для тестирования нашего шлюза необходимо связаться с менеджером.

HTTP-шлюз

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

XML-шлюз

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

Загрузить примеры

Здесь Вы сможете скачать примеры скриптов, для работы с выбранным шлюзом

Метод JSON
Одиночная   pdf
Массовая
Баланс
Статусы
Альфа-имена
TOP