Інтеграція API для надсилання СМС
SMS Club пропонує приєднання до інтерфейсу (SMS-шлюз) для автоматичного розсилання 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
Для надсилання SMS-повідомлень через API необхідно задати такі дані:
src_addr
Телефон
(не більше 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С |
|---|---|---|
| Поодинока |
|
|
| Масова |
|
|
| Баланс |
|
|
| Статуси |
|
|
| Альфа-імена |
|
