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

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

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


HTTP/HTTPS SMTP SMPP SOAP OMS SMS-команди Бібліотеки та приклади коду

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

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

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

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

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

Надсилання MMS-повідомлення

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

РІЗНЕ

Отримання даних

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

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
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

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

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

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
hourПеріод в годинах, за який необхідно запросити вхідні повідомлення. Максимальна кількість годин-168 (7 днів).
after_idІдентифікатор повідомлення, починаючи з якого необхідно повернути вхідні повідомлення, за винятком самого after_id.
to_phoneНомер телефону Клієнта, на який отримані вхідні повідомлення.

У разі помилки Сервер повертає наступний рядок:
  • 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-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
4IP-адреса тимчасово заблокована.
9Спроба відправки більше трьох однакових запитів на отримання списку вхідних повідомлень протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді рядка:
  • при fmt = 0:
    id = <id>, received = <received>, phone = <phone>, message = <message>, to_phone = <to_phone>, sent = <sent>
    ...

  • при fmt = 1:
    <id>,<received>,<phone>,<to_phone>,<sent>,<message>
    ...

  • при fmt = 2:
    <sms_answers>
    <sms>
    <id>id</id>
    <received>received</received>
    <phone>phone</phone>
    <message>message</message>
    <to_phone>to_phone</to_phone>
    <sent>sent</sent>
    </sms>
    ...
    </sms_answers>

  • при fmt = 3:
    [{
    "id": <id>,
    "received": "<received>",
    "phone": "<phone>",
    "message": "<message>",
    "to_phone": "<to_phone>",
    "sent": "<sent>"
    },
    ...]

Де:
<id> – ідентифікатор вхідного повідомлення, що призначається Сервером автоматично.
<received> – дата отримання повідомлення Сервером. Формат DD.MM.YYYY HH:mm: ss.
<phone> – номер телефону абонента.
<message> – вхідне повідомлення.
<to_phone> – номер телефону одержувача.
<sent> – дата відправки повідомлення. Формат DD.MM.YYYY hh:mm:ss.


Приклади:

Отримання списку вхідних повідомлень за поточну добу:

https://smsc.ua/sys/get.php?get_answers=1&login=alex&psw=123
Отримання списку вхідних повідомлень за останні 48 годин:

https://smsc.ua/sys/get.php?get_answers=1&login=alex&psw=123&hour=48
Отримання списку вхідних повідомлень з ідентифікаторами, великими id= " 1234567":

https://smsc.ua/sys/get.php?get_answers=1&login=alex&psw=123&after_id=1234567

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

Отримання статистики

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
startПочаткова дата в періоді, за який запитується статистика. Формат: 'дд.мм. рррр'.
endКінцева дата в періоді. Якщо не вказана, то повертаються дані з початкової дати. Формат: 'дд.мм. рррр'.
mycurПрапор, що дозволяє виводити статистику в поточній валюті клієнта.
balance2Прапор, що дозволяє отримати статистику по відправленим повідомленням, оплаченим з електронного балансу.

У разі помилки Сервер повертає наступний рядок:
  • 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-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
4IP-адреса тимчасово заблокована.
9Спроба відправки більше трьох однакових запитів на отримання списку вхідних повідомлень протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді рядка:
  • при fmt = 0:
    login = <login>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency>
    ...

  • при fmt = 1:
    <login>,<cnt>,<credit>,<debit>,<currency>
    ...

  • при fmt = 2:
    <list>
    <stat>
    <login>login</login>
    <sms>cnt</sms>
    <credit>credit</credit>
    <debit>debit</debit>
    <currency>currency</currency>
    </stat>
    ...
    </list>

  • при fmt = 3:
    [{
    "login": "<login>",
    "sms": "<cnt>",
    "credit": "<credit>",
    "debit": "<debit>",
    "currency": "<currency>"
    },
    ...]

Де:
<login> - логін Клієнта.
<cnt> - кількість повідомлень.
<credit> - витрати.
<debit> - надходження.
<currency> - трисимвольний код валюти.

Приклади:

Отримання статистики в поточній валюті Клієнта з "01.01.2014" по "01.02.2014" за безготівковим балансом:

https://smsc.ua/sys/get.php?get_stat=1&login=alex&psw=123&mycur=1&start=01.01.2014&end=01.02.2014

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

Отримання статистики по оператору Мегафон

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
accountНомер особового рахунку у оператора Мегафон.

У разі помилки Сервер повертає наступний рядок:
  • 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:
    account = <account>, phone = <phone>, sms_mon = <sms_mon>, sms_day = <sms_day>, sms_yes = <sms_yes>, sms_pmon = <sms_pmon>, balance = <balance>, credit = <credit>, senders = <senders>
    ...

  • при fmt = 1:
    <account>,<phone>,<sms_mon>,<sms_day>,<sms_yes>,<sms_pmon>,<balance>,<credit>,<senders>
    ...

  • при fmt = 2:
    <accounts>
    <account>
    <number>number</number>
    <phone>phone</phone>
    <sms_mon>sms_mon</sms_mon>
    <sms_day>sms_day</sms_day>
    <sms_yes>sms_yes</sms_yes>
    <sms_pmon>sms_pmon</sms_pmon>
    <balance>balance</balance>
    <credit>credit</credit>
    <senders>senders</senders>
    </account>
    ...
    </accounts>

  • при fmt = 3:
    [{
    "account": "<account>",
    "phone": "<phone>",
    "sms_mon": <sms_mon>,
    "sms_day": <sms_day>,
    "sms_yes": <sms_yes>,
    "sms_pmon": <sms_pmon>,
    "balance": "<balance>",
    "credit": <credit>,
    "senders": "<senders>"
    },
    ...]

Де:
<account> - номер особового рахунку.
<phone> - телефон, прив'язаний до особового рахунку.
<sms_mon> - кількість смс, відправлених за поточний місяць.
<sms_day> - кількість смс, відправлених за поточний день.
<sms_yes> - кількість смс, відправлених за попередній день.
<sms_pmon> - кількість смс, відправлених за попередній місяць.
<balance> - баланс.
<credit> - кредит.
<senders> - зареєстровані імена відправників.

Приклади:

Отримання статистики по всіх особових рахунках:

https://smsc.ua/sys/get.php?get_mega_accounts=1&login=alex&psw=123
Отримання статистики по особовому рахунку "111":

https://smsc.ua/sys/get.php?get_mega_accounts=1&login=alex&psw=123&account=111

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

Запит тарифів

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).

У разі помилки Сервер повертає наступний рядок:
  • 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-адреси, що не входить в список дозволених Клієнтом (якщо такий список був налаштований Клієнтом раніше).
4IP-адреса тимчасово заблокована.
9Спроба відправки більше трьох однакових запитів на отримання списку тарифів протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді набору рядків:
  • при fmt = 0:
    zone = <zone>, name = <name>, api = <api>, mass = <mass>, mms = <mms>, hlr = <hlr>, call = <call>
    ...

    при наявності встановлених індивідуальних тарифів за певними операторами до відповіді додається набір рядків:
    mccmnc = <mccmnc>, cost = <cost>
    ...

    mail = <mail>

  • при fmt = 1:
    <zone>,<name>,<api>,<mass>,<mms>,<hlr>,<call>
    ...

    <mccmnc>,<cost>
    ...

    <mail>

  • при fmt = 2:
    <price>
    <zones>
    <zone name="<name>" api="<api>" mass="<mass>" mms="<mms>" hlr="<hlr>" call="<call>">zone</zone>
    ...
    </zones>
    <codes>
    <mccmnc cost="<cost>">mccmnc</mccmnc>
    ...
    </codes>
    <mail>mail</mail>
    </price>

  • при fmt = 3:
    {
    "zones": [{
    "zone": "<zone>",
    "name": "<name>",
    "api": "<api>",
    "mass": "<mass>",
    "mms": "<mms>",
    "hlr": "<hlr>",
    "call": "<call>"
    },
    ...
    {
    ...
    }],
    "codes": [{
    "mccmnc": "<mccmnc>",
    "cost": "<cost>"
    },
    ...
    {
    ...
    }],
    "mail": "<mail>"
    }

Де:
<zone> - тарифна зона.
<name> - назва тарифної зони (оператор, країна тощо.).
<api> - вартість SMS при відправці через API.
<mass> - вартість SMS при відправці через Особистий кабінет.
<mms> - вартість MMS-повідомлення.
<hlr> - вартість HLR-запиту.
<call> - вартість голосового повідомлення (дзвінок).
<mccmnc> - код країни і мобільного оператора, для якого встановлено індивідуальний тариф.
<cost> - вартість повідомлення за даним індивідуальним тарифом.
<mail> - вартість e-mail повідомлення.

Приклади:

Отримання списку тарифів:

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

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

Отримання інформації про оператора

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
phoneНомер телефону абонента або список номерів через кому.

У разі помилки Сервер повертає наступний рядок:
  • 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Спроба відправки більше трьох однакових запитів або будь-яких 100 запитів на отримання інформації про оператора абонента протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

При успішному запиті Сервер повертає відповідь у вигляді рядка або списку рядків при множиному запиті (у цьому випадку у відповідь Сервера додається параметр " phone"):

  • при fmt = 0: country = <country>, operator = <operator>, region = <region>, mcc = <mcc>, mnc = <mnc>, tz = <tz>

  • при fmt = 1: <country>,<operator>,<region>,<mcc>,<mnc>,<tz>

  • при fmt = 2:
    <info>
    <country>country</country>
    <operator>operator</operator>
    <region>region</region>
    <mcc>mcc</mcc>
    <mnc>mnc</mnc>
    <tz>tz</tz>
    </info>

    При множинному запиті конструкції <info> заключаються в тег <list>.

  • при fmt = 3:
    {
    "country": "<country>",
    "operator": "<operator>",
    "region": "<region>",
    "mcc": "<mcc>",
    "mnc": "<mnc>",
    "tz": "<tz>"
    }

Де:
<phone> – номер телефону абонента.
<country> – назва країни реєстрації номера абонента.
<operator> – мобільний оператор абонента.
<region> – регіон реєстрації номера абонента.
<mcc> – числовий код країни абонента.
<mnc> – числовий код оператора абонента.
<tz> – часовий пояс регіону реєстрації номера абонента.


Приклад:

Отримання інформації про оператора абонента з номером " 79999999999":

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

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

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

Отримання даних о короткому посиланні

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
linkВихідне повне посилання.
idІдентифікатор короткого посилання. Призначається автоматично при створенні.

У разі помилки Сервер повертає наступний рядок:
  • 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: id = <id>, cnt = <cnt>, cnt_mon = <cnt_mon>, cnt_day = <cnt_day>, cnt_yes = <cnt_yes>, cnt_pmon = <cnt_pmon>, link = <link>

  • при fmt = 1: <id>,<cnt>,<cnt_mon>,<cnt_day>,<cnt_yes>,<cnt_pmon>,<link>

  • при fmt = 2:
    <result>
    <id>id</id>
    <cnt>cnt</cnt>
    <cnt_mon>cnt_mon</cnt_mon>
    <cnt_day>cnt_day</cnt_day>
    <cnt_yes>cnt_yes</cnt_yes>
    <cnt_pmon>cnt_pmon</cnt_pmon>
    <link>link</link>
    </result>

  • при fmt = 3:
    {
    "id": "<id>",
    "cnt": "<cnt>",
    "cnt_mon": "<cnt_mon>",
    "cnt_day": "<cnt_day>",
    "cnt_yes": "<cnt_yes>",
    "cnt_pmon": "<cnt_pmon>",
    "link": "<link>"
    }

Де:
<id> – ідентифікатор короткого посилання.
<cnt> – кількість всіх переходів за коротким посиланням.
<cnt_mon> – кількість переходів за коротким посиланням за місяць.
<cnt_day> – кількість переходів за коротким посиланням за сьогодні.
<cnt_yes> – кількість переходів за коротким посиланням за вчора.
<cnt_pmon> – кількість переходів за коротким посиланням в попередньому місяці.
<link> – коротке посилання.


Приклад:

Отримання інформації про коротке посилання з id="145142":

https://smsc.ua/sys/tinyurls.php?get=1&login=alex&psw=123&id=145142
Отримання інформації про коротке посилання за повним вихідним посиланням "mywebsite.ru":

https://smsc.ua/sys/tinyurls.php?get=1&login=alex&psw=123&link=mywebsite.ru

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




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