Интеграция API для отправки СМС
SMS Club предлагает присоединение к интерфейсу (SMS-шлюз) для автоматической рассылки СМС. Интегрировать сервис реально с любым проектом.
Подключение к СМС-шлюзу сервиса нашей компании — бесплатно без активации услуги. Единственное условие: кодировка данных для передачив API обязана быть — UTF-8.
Спецификация JSON:API
*рекомендовано
Для связи с сервером браузеру необходим способ POST. На необходимый адрес отправляются запросы по протоколу HTTP, для этого используется стандартный формат текста — JSON (JavaScript Object Notation).
Право доступа к ресурсам пользователя осуществляется через протокол авторизации OAuth 2.0. Чтобы аутентифицировать запросы необходим токен, для получения которого зайдите в Личный кабинет в раздел Профиль. Выберите token и вставьте его в шапку запроса: 'Authorization: Bearer your_token'.
Обратите внимание! Лимит на количество запросов (доступ к API ) — до 9 шт/сек от каждого пользователя.
СМС рассылка через API
Интернет-адрес службы: https://im.smsclub.mobi/sms/send
Для отправки смс-уведомлений через API необходимо задать следующие данные:
src_addr
phone
(не более 100 шт.в одном запросе)
message
integration_id
Результативная отправка уведомлений в партнерскую систему подтверждается возвратом массива, где «info» — это ключ, id уведомления в системе СМС Клуб. По этому id присваивается статус, где телефонный номер абонента, которому отправлялось СМС — значение. См.образец: «107» - id sms, 380989371132 — номер клиента.
Пример отправки сообщения в «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" : ["107"],
}
Вариант ответа:
{
"success_request": {
"info": {
"107": "ENROUTE"
}
}
}
Варианты статуса
200 – Успех! Запрос выполнен. Вероятные статусы уведомлений:
ENROUTE
DELIVRD
EXPIRED
UNDELIV
REJECTD
Ошибки
400
401
429
453
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": "8121.1800",
"currency": "UAH"
]
}
}
SMPP-шлюз
ESME
SMSC
MSC
SMS, EMS, WAP, USSD, ets
Аппаратный маршрутизатор соответствует протоколу SMPP v3.4. Чтобы протестировать аппаратный маршрутизатор, свяжитесь с нашим специалистом.
HTTP-шлюз
Сетевой шлюз отсылает HTTP запросы на назначенный URL сервиса. Для отправки используется протокол HTTP и методы GET/POST. Чтобы протестировать маршрутизатор, обратитесь к нашим специалистам.
XML-шлюз
Аппаратный маршрутизатор предназначен для отправки XML-запросов по назначенному адресу. Закодированные в UTF-8 запросы, уходят по протоколу HTTP, используя способ POST. Для проверки сетевого шлюза, свяжитесь с нашим специалистом.
Загрузка образцов
Выберите шлюз и скачайте образцы скриптов.
| Метод | JSON | 1С |
|---|---|---|
| Одиночная |
|
|
| Массовая |
|
|
| Баланс |
|
|
| Статусы |
|
|
| Альфа-имена |
|
