API інтеграція SMS
СМС-шлюз дозволяє автоматизувати розсилку sms повідомлень та вбудувати сервіс у будь-який проект
Ви можете безкоштовно підключитись до нашого смс-шлюзу, активація послуги не потрібна. Усі дані, що передаються в API, повинні бути в кодуванні UTF-8.
JSON API
*рекомендований метод
Спілкування з сервісом здійснюється за допомогою надсилання HTTP-запитів, методом POST, на задану адресу використовуючи текстовий формат обміну даними JSON.
Для аутентифікації запиту використовується OAuth 2. При цьому виді аутентифікації необхідно використовувати token, який можна отримати в особистому кабінеті розділу «Профіль». Після чого відповідно включити даний токен в заголовок запиту, наприклад: 'Authorization: Bearer your_token'.
Увага: обмеження частоти запитів до сервісу має бути не більше 9 запитів на секунду від одного клієнта.
Надсилання повідомлень API
Адреса служби: https://im.smsclub.mobi/sms/send
Надсилання повідомлень здійснюється за допомогою завдання нижчеописаних параметрів:
src_addr
йде відправка
phone
(до 100 за запит)
message
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 – Запит успішно опрацьовано. Можливі статуси повідомлень:
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": "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 | 1С |
|---|---|---|
| Поодинока |
|
|
| Масова |
|
|
| Баланс |
|
|
| Статуси |
|
|
| Альфа-імена |
|
