За допомогою сервісу API Sms Ви можете надсилати sms повідомлення з стороннього сайту через нашу систему.
Всі параметри передаються методом GET або POSTАдреса для запитів:
https://my.oneipower.com/api/sms/http/
Приклад запиту:
https://my.oneipower.com/api/sms/http/?command=send&key=KEY&from=oneiPOWER&to=380964138489&message=test
Параметри для надсилання повідомлення:
Параметр | Обов'язково | Опис |
---|---|---|
command | так | Доступне значення send. |
key | так | Ваш унікальний ключ, який використовується для авторизації на сервері. Отримати можна в закладці "Налаштування". |
from | ні | Ім'я відправника (альфа-ім'я). Доступні імена знаходяться у панелі меню зліва "Імена відправників". Якщо параметр не буде переданий або залишиться пустий система використає ім'я за замовчуванням Test. |
to | так | Телефон отримувача в міжнародному форматі, наприклад 380964138489. |
message | так | Текст повідомлення в кодуванні UTF-8. |
translit | ні | Автоматична транслітерація повідомлення. Можливі значення 1 або 0. Якщо встановити значення параметру 1, повідомлення автоматично буде транслфтеровано. Якщо не вказувати даний параметр або встановити значення 0, повідомлення залишиться незмінним та вважатиметься надісланим на кирилиці. |
ask_date | ні | Дата і час відправки повідомлення в форматі ISO-8601: 2009-08-15T15:52:01+0200. Якщо залишити параметр пустим або не вказувати його, відправка повідомлення відбудеться миттєво. |
test | ні | Якщо зазначений параметр text із будь-яким значенням, в разі відсутності помилок, система покаже повідомлення успішної відправки із id:1234567, але реальне надсилання повідомлення не відбудеться. |
id:{MESSAGE_ID}
Результат роботи у випадку помилок:
errors:{ERROR_TEXT}
Можливі варіанти помилок:
- Sender phone should contains only english letters, digits, dot, underscore, dash
- Please enter valid receiver phone number
- Please enter SMS text
- SMS is too long
- Not enough money
- No such user
- Service temporarily unavailable. Please try again later
Параметри для отримання статусу надісланого повідомлення:
Параметр | Обов'язково | Опис |
---|---|---|
command | так | Доступне значення receive. |
key | так | Ваш унікальний ключ, який використовується для авторизації на сервері. Отримати можна в закладці "Налаштування". |
id | так | Номер, виданий після успішно надісланого повідомлення командою "send". |
Результат роботи у випадку успішної відповіді:
status:{STATUS_CODE}
Можливі статуси:
errors:{ERROR_TEXT}
Можливі варіанти помилок:
status:{STATUS_CODE}
Можливі статуси:
- 0 - Очікує
- 1 - Надсилається
- 2 - Надіслано
- 3 - Доставлено
- 5 - Немає на зв'язку
- 50 - Частково доставлено
- 96 - Збій мережі при доставці SMS
- 99 - Помилка в номері
- 99 - Номер не обслуговується
errors:{ERROR_TEXT}
Можливі варіанти помилок:
- SMS not found
Параметри для отримання вартості повідомлення:
Параметр | Обов'язково | Опис |
---|---|---|
command | так | Доступне значення price. |
key | так | Ваш унікальний ключ, який використовується для авторизації на сервері. Отримати можна в закладці "Налаштування". |
phone | так | Телефон отримувача в міжнародному форматі, наприклад 380964138489. |
price:{SMS_PRICE}
Якщо ціна не вказана — доставка на вказаний номер не виконується.
Параметри для отримання балансу користувача у валюті України (гривня):
Параметр | Обов'язково | Опис |
---|---|---|
command | так | Доступне значення balance. |
key | так | Ваш унікальний ключ, який використовується для авторизації на сервері. Отримати можна в закладці "Налаштування". |
balane:{AMOUNT}
Внесення та видалення номерів із телефонної книги:
Параметр | Обов'язково | Опис |
---|---|---|
command | так | Доступне значення phonebook. |
key | так | Ваш унікальний ключ, який використовується для авторизації на сервері. Отримати можна в закладці "Налаштування". |
group | ні | Номер групи в телефонній книзі (відображається в розділі Телефонна книга біля назви групи в дужках) в якій необхідно виконувати операції. Якщо параметр не переданий, по замовчуванню вибирається група з назвою "Без групи". |
action | так | Назва операції з номером. Доступні два значення add та delete. |
phone | так | Номер телефону з яким необіхдно виконати дію. |
status:ok
Результат роботи у випадку помилок:
errors:{ERROR_TEXT}
Можливі варіанти помилок:
- Sender phone should contains only english letters, digits, dot, underscore, dash
- Please enter valid phone number
- Phone group not found
- Phone number not found
- Phone already exist in group
- No such action command
- No such user