Тарифи  Послуги  API  Партнерам  Про сервіс  Контакти 
0 (800) 30 7672
Безкоштовно по Україні
 

Інтеграція з сервісом (API)

API дозволяє розсилати повідомлення через ваші проекти і сервіси по протоколах HTTP/HTTPS, SMTP і SMPP. Готові бібліотеки різними мовами програмування підключаються до вашого проекту та допомагають надсилати повідомлення з будь-якого місця за допомогою однієї команди. Для спрощеної авторизації замість пари логін і пароль можна використовувати спеціальний API-ключ.
HTTP/HTTPS SMTP SMPP SOAP OMS SMS-команди Бібліотеки та приклади коду

ВІДПРАВКА ПОВІДОМЛЕНЬ

Відправка SMS-повідомлення

Коментарі в SMS-повідомленнях

Відправка на групу номерів

Відправка HLR-запиту

Відправка e-mail повідомлення

Надсилання голосового повідомлення (дзвінок)

Відправка viber-повідомлення

Відправлення повідомлення в Telegram

Відправлення повідомлення в чат-бот Telegram

Використання префіксів при відправці повідомлень

Керування шаблонами повідомлень

Керування шаблонами операторів

Віртуальна відправка (режим тестування)

Повідомлення про події

УПРАВЛІННЯ РОЗСИЛКАМИ

СТАТУСИ ПОВІДОМЛЕНЬ

ПЕРЕВІРКА СТАНУ БАЛАНСУ

УПРАВЛІННЯ КОНТАКТАМИ

УПРАВЛІННЯ КЛІЄНТАМИ

КЕРУВАННЯ ІМЕНАМИ ВІДПРАВНИКІВ (SENDER ID)

ОТРИМАННЯ ДАНИХ

РІЗНЕ

Отримання історії відправлених повідомлень

Для отримання списку відправлених SMS-повідомлень необхідно викликати методом GET або POST адресу: https://smsc.ua/sys/get.php?get_messages=1&login=<login>&psw=<password>
Опис параметрів, що передаються Серверу:

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
apikeyСпеціальний API-ключ, який використовується для спрощеної авторизації замість пари "логін + пароль" (можна створити на даний сторінка).
startПочаткова дата в періоді, за який запитується історія. Формат: 'дд.мм. рррр'. Максимальний період, за який можливий запит історії відправлених повідомлень, становить півроку.
endКінцева дата в періоді. Якщо не вказана, то повертаються дані з початкової дати. Формат: 'дд.мм. рррр'.
phoneНомер або розділений комами список номерів телефонів, для яких необхідно отримати історію відправлених SMS-повідомлень.
emailE-mail адреса або розділений комами список адрес, для яких необхідно отримати історію відправлених e-mail повідомлень.
formatОзнака запиту e-mail повідомлень.
0 (за замовчуванням) – запит SMS-повідомлень.
8 – запит e-mail повідомлень.
cntКількість повідомлень, що повертаються у відповіді. Максимальне значення становить 1000.
prev_idГлобальний ідентифікатор повідомлення (параметр int_id у відповіді Сервера), який призначається сервером автоматично. Використовується для запиту списку повідомлень, відправлених до повідомлення із вказаним ідентифікатором.
fmtФормат відповіді Сервера.
0 – (за замовчуванням) у вигляді рядка (докладніше можна ознайомитися в описі нижче).
1 – повернути відповідь у вигляді параметрів через кому.
2 – відповідь у xml форматі.
3 – відповідь у json форматі.

У разі помилки Сервер повертає наступний рядок:
  • ERROR = N (опис)

  • При fmt = 1:
    0,-N

  • При fmt = 2:
    <result>
    <error>опис</error>
    <error_code>N</error_code>
    </result>

  • При fmt = 3:
    {
    "error": "опис",
    "error_code": N
    }
N – номер помилки, може приймати наступні значення:

ЗначенняОпис
1Помилка в параметрах.
2Невірний логін або пароль. Також виникає при спробі відправки повідомлення з IP-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
3Повідомлення не знайдене.
4IP-адреса тимчасово заблокована.
9Спроба відправки більше трьох однакових запитів на отримання історії вихідних повідомлень протягом хвилини або більше тридцяти запитів протягом години.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді рядка:
  • при fmt = 0:
    Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, mccmnc = <mccmnc>, country = <country>, operator = <operator>, region = <region>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, type = <type>, ID = <id>, int_id = <int_id>, sms_cnt = <sms_cnt>, format = <format>, crc = <crc>
    ...

  • при fmt = 1:
    <status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<mccmnc>,<country>,<operator>,<region>,<cost>,<sender>,<status_name>, <message>,<type>,<id>,<int_id>,<sms_cnt>,<format>,<crc>
    ...

  • при fmt = 2:
    <list>
    <sms>
    <status>status</status>
    <last_date>last_date</last_date>
    <last_timestamp>last_timestamp</last_timestamp>
    <err>err</err>
    <send_date>send_date</send_date>
    <send_timestamp>send_timestamp</send_timestamp>
    <phone>phone</phone>
    <cost>cost</cost>
    <sender_id>sender</sender_id>
    <status_name>status_name</status_name>
    <message>message</message>
    <mccmnc>mccmnc</mccmnc>
    <country>country</country>
    <operator>operator</operator>
    <region>region</region>
    <type>type</type>
    <id>id</id>
    <int_id>int_id</int_id>
    <sms_cnt>sms_cnt</sms_cnt>
    <format>format</format>
    <crc>crc</crc>
    </sms>
    ...
    </list>

  • при fmt = 3:
    [{
    "status": <status>,
    "last_date": "<last_date>",
    "last_timestamp": <last_timestamp>,
    "err": <err>,
    "send_date": "<send_date>",
    "send_timestamp": <send_timestamp>,
    "phone": "<phone>",
    "cost": "<cost>",
    "sender_id": "<sender>",
    "status_name": "<status_name>",
    "message": "<message>",
    "mccmnc": "<mccmnc>",
    "country": "<country>",
    "operator": "<operator>",
    "region": "<region>",
    "type": <type>,
    "id": <id>,
    "int_id": "<int_id>",
    "sms_cnt": <sms_cnt>,
    "format": <format>,
    "crc": <crc>
    ...]

Де:
<status> – код статусу (список)
<last_date> – дата останньої зміни статусу. Формат DD.MM.YYYY HH:mm: ss.
<last_timestamp> – штамп часу останньої зміни статусу.
<err> – код помилки, якщо повідомлення не було доставлене.
<send_date> – дата відправки повідомлення (формат DD.MM.YYYY hh:mm:ss).
<send_timestamp> – штамп часу відправки повідомлення.
<phone> – номер телефону абонента.
<country> – назва країни реєстрації номера абонента.
<operator> – назва оператора абонента.
<region> – регіон реєстрації номера абонента.
<type> – тип повідомлення.
<cost> – вартість повідомлення.
<sender> – ім'я відправника.
<status_name> – назва статусу.
<message> – текст повідомлення.
<mccmnc> – мобільний код країни і мобільний код оператора.
<id> – ідентифікатор повідомлення.
<int_id> – глобальний ідентифікатор повідомлення.
<sms_cnt> – кількість частин в повідомленні.
<format> – формат повідомлення.
<crc> – контрольна сума повідомлення.

Приклади:

Отримання останніх десяти вихідних SMS-повідомлень:

https://smsc.ua/sys/get.php?get_messages=1&login=alex&psw=123&cnt=10
Отримання останнього вихідного SMS-повідомлення, відправленого на номер "79999999999":

https://smsc.ua/sys/get.php?get_messages=1&login=alex&psw=123&phone=79999999999

Сервер не приймає більше трьох однакових запитів протягом хвилини або тридцяти запитів протягом години на отримання історії вихідних повідомлень для зниження навантаження і захисту від помилок і зациклення в програмі на стороні Клієнта.




© 2003–2024 ТОВ " СМСЦЕНТР»
Код ЄДРПОУ 38404962 		support@smsc.ua
Контакти 		Дизайн — Студія Артемія Лебедєва
Інформація про сайт 		SMS-центр для Android Яндекс.Метрика