Тарифи  Послуги  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)

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

РІЗНЕ

Управління контактами

Дії з контактами і групами

Для управління контактами або групами необхідно викликати методом GET або POST відповідну адресу із зазначенням необхідної команди і параметрів.

Для створення контакту: https://smsc.ua/sys/phones.php?add=1&login=<login>&psw=<password>&phone=<phone>&name=<name>
Для створення нової групи: https://smsc.ua/sys/phones.php?add_group=1&login=<login>&psw=<password>&name=<name>
Для зміни номера телефону в контакті: https://smsc.ua/sys/phones.php?chg=1&login=<login>&psw=<password>&phone=<phone>&new_phone=<new_phone>
Для зміни назви групи: https://smsc.ua/sys/phones.php?chg_group=1&login=<login>&psw=<password>&grp=<group_id>&name=<name>
Для перенесення контакту в нову групу: https://smsc.ua/sys/phones.php?move_group=1&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для додавання нової групи до контакту: https://smsc.ua/sys/phones.php?move_group=2&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для видалення контакту з групи: https://smsc.ua/sys/phones.php?move_group=3&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для видалення контакту: https://smsc.ua/sys/phones.php?del=1&login=<login>&psw=<password>&phone=<phone>
Для видалення групи: https://smsc.ua/sys/phones.php?del_group=1&login=<login>&psw=<password>&grp=<group_id>
Для виведення списку контактів: https://smsc.ua/sys/phones.php?get=1&login=<login>&psw=<password>
Для виведення списку груп: https://smsc.ua/sys/phones.php?get_group=1&login=<login>&psw=<password>
Для додавання запису в" чорний " список: https://smsc.ua/sys/phones.php?add_black=1&login=<login>&psw=<password>&phone=<phone>
Для видалення запису з" чорного " списку: https://smsc.ua/sys/phones.php?del_black=1&login=<login>&psw=<password>&phone=<phone>
Для отримання елементів "чорного" списку: https://smsc.ua/sys/phones.php?get_black=1&login=<login>&psw=<password>

Опис параметрів

Опис параметрів, що передаються Серверу:

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
nameНазва контакту або групи.
grpІдентифікатор групи, якій належить контакт, який створюється. Можна прив'язати контакт відразу до декількох груп, вказавши їх ідентифікатори через кому.
numНомер групи для розсилок повідомлень.
phoneСписок номерів телефонів через будь-який роздільник (команда add), або номер телефону (команда move_group, add_black). Використовується для операцій з номерами телефонів у скрипті phones.php.
mailСписок e-mail адрес через будь-який роздільник (команда add), або e-mail адреса (команда move_group, add_black). Використовується для операцій з e-mail адресами в скрипті mails.php. Формат запитів аналогічний формату для phones.php.
new_phoneНовий список номерів телефонів через будь роздільник (команда chg).
new_mailНовий список e-mail адрес через будь-який роздільник (команда chg).
lnmПрізвище.
fnmІм'я.
mnmПо батькові.
fioПІБ контакту. Цей параметр використовується в команді get для отримання списку контактів по будь-якому з ініціалів (прізвища, імені та (або) по-батькові).
searchВибірка контактів для команди get за назвою контакту та (або) номером телефону.
after_idІдентифікатор контакту (int_id), починаючи з якого необхідно повернути список контактів (команда get, формат fmt=3), за винятком самого after_id.
bdДата народження у форматі дд.мм.рррр.
myidID контакту, призначений Клієнтом.
cmtКоментарі.
tagsТеги (мітки).
phoІнші номери телефонів. За даними номерами розсилка SMS-повідомлень не виконується.
typeТип блокування (команда add_black):
0 – всі повідомлення.
1 – масові розсилки.
2 – поодинокі повідомлення.
Або тип групи (команда add_group і get_group):
0 – група для номерів телефонів.
1 – група для E-mail адрес.
prev_idГлобальний ідентифікатор елемента" чорного " списку (параметр id у відповіді Сервера), що призначається Сервером автоматично. Використовується в команді get_black для запиту елементів "чорного списку", доданих раніше до даного елемента.
cntКількість записів, що повертаються у відповіді Сервера. Максимальне значення дорівнює 1000.
fmtФормат відповіді сервера:
0 – (за замовчуванням) у вигляді рядка (ID = 12345).
1 – у вигляді рядка (12345).
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-адреса тимчасово заблокована.
5Помилка виконання операції.
9Спроба відправки більше трьох однакових запитів на операції з групами, контактами або записами "чорного" списку протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).

У разі успішного запиту Сервер повертає відповідь у вигляді рядка.

При створенні контакту, групи контактів, записи "чорного" списку:
  • при fmt = 0: ID = <id>

  • при fmt = 1: <id>

  • при fmt = 2 (створення контакту, запису "чорного" списку):
    <phone>
    <id>id</id>
    </phone>

  • при fmt = 2 (створення групи):
    <group>
    <id>id</id>
    </group>

  • при fmt = 3:
    {
    "id": <id>
    }

Де <id> - ідентифікатор контакту, групи або запису "чорного" списку, призначений Сервером автоматично.

При зміні або видаленні контакту (групи), видаленні запису "чорного" списку:
  • при fmt = 0,1: OK

  • при fmt = 2: <result>OK</result>

  • при fmt = 3:
    {
    "result": "OK"
    }


При запиті списку контактів:
  • при fmt = 0:
    phone = <phone>, name = <name>, group = <group>, first_name = <first_name>, last_name = <last_name>, middle_name = <middle_name>, birthday = <birthday>, id = <id>, comments = <comments>, tags = <tags>, phone_other = <phone_other>
    ...

  • при fmt = 1:
    <phone>,<name>,<group>,<first_name>,<last_name>,<middle_name>,<birthday>,<id>,<comments>,<tags>,<phone_other>
    ...

  • при fmt = 2:
    <list>
    <contact>
    <phone>phone</phone>
    <name>name</name>
    <group>group</group>
    <first_name>first_name</first_name>
    <last_name>last_name</last_name>
    <middle_name>middle_name</middle_name>
    <birthday>birthday</birthday>
    <id>id</id>
    <comments>comments</comments>
    <tags>tags</tags>
    <phone_other>phone_other</phone_other>
    </contact>
    ...
    </list>

  • при fmt = 3:
    [{
    "phone": "<phone>",
    "name": "<name>",
    "group": <group>,
    "first_name": "<first_name>",
    "last_name": "<last_name>",
    "middle_name": "<middle_name>",
    "birthday": "<birthday>",
    "id": "<id>",
    "comments": "<comments>",
    "tags": "<tags>",
    "phone_other": "<phone_other>"
    },
    ...]

Де:
<phone> – список номерів телефонів через будь-який роздільник. Для e-mail адрес замінюється на <mail>.
<name> – назва контакту.
<group> – ідентифікатор групи, до якої належить контакт.
<first_name> – ім'я.
<last_name> – прізвище.
<middle_name> – по батькові.
<birthday> – дата народження у форматі дд.мм.рррр.
<id> – id контакту, призначений Клієнтом.
<comments> – коментарі.
<tags> – теги (мітки).
<phone_other> - інші номери телефонів. За даними номерами розсилка повідомлень не виконується. Для e-mail адрес замінюється на <mail_other>.

При запиті списку груп:
  • при fmt = 0:
    id = <id>, name = <name>, number = <number>, cnt = <cnt>
    ...

  • при fmt = 1:
    <id>,<name>,<number>,<cnt>
    ...

  • при fmt = 2:
    <list>
    <group>
    <id>id</id>
    <name>name</name>
    <number>number</number>
    <cnt>number</cnt>
    </group>
    ...
    </list>

  • при fmt = 3:
    [{
    "id": <id>,
    "name": "<name>",
    "number": <number>,
    "cnt": "<cnt>"
    },
    ...]

Де:
<id> – ідентифікатор групи, призначений Сервером при створенні.
<name> – назва групи.
<number> – номер групи для розсилок.
<cnt> – кількість контактів у групі.

При запиті елементів "чорного" списку:
  • при fmt = 0:
    id = <id>, phone = <phone>, type = <type>, comment = <comment>
    ...

  • при fmt = 1:
    <id>,<phone>,<type>,<comment>
    ...

  • при fmt = 2:
    <list>
    <record>
    <id>id</id>
    <phone>phone</phone>
    <type>type</type>
    <comment>comment</comment>
    </record>
    ...
    </list>

  • при fmt = 3:
    [{
    "id": <id>,
    "phone": "<phone>",
    "type": <type>,
    "comment": "<comment>"
    },
    ...]

Де:
<id> – ідентифікатор елемента, призначений Сервером при створенні.
<phone> – номер телефону (або <email> при запиті" чорного " списку e-mail).
<type> – тип блокування: 0-всі повідомлення, 1-масові розсилки, 2-поодинокі повідомлення.
<comment> – коментарі.

Приклади операцій з контактами

Приклади:

Створення контакту з іменем "Contact", що належить групі з ID = 321:

https://smsc.ua/sys/phones.php?add=1&login=alex&psw=123&phone=79999999999&name=Contact&grp=321
Створення групи з іменем "Group":

https://smsc.ua/sys/phones.php?add_group=1&login=alex&psw=123&name=Group
Зміна імені контакту з номером телефону "79999999999 "на нове ім'я "Contact1":

https://smsc.ua/sys/phones.php?chg=1&login=alex&psw=123&phone=79999999999&name=Contact1
Зміна назви групи з ID = 321 на нову назву " Group1":

https://smsc.ua/sys/phones.php?chg_group=1&login=alex&psw=123&grp=321&name=Group1
Видалення контакту з номером телефону "79999999999":

https://smsc.ua/sys/phones.php?del=1&login=alex&psw=123&phone=79999999999
Видалення групи з ID = 321:

https://smsc.ua/sys/phones.php?del_group=1&login=alex&psw=123&grp=321
Отримання списку контактів, що належать групі з ID = 321:

https://smsc.ua/sys/phones.php?get=1&login=alex&psw=123&grp=321
Отримання даних контакту з номером телефону "79999999999":

https://smsc.ua/sys/phones.php?get=1&login=alex&psw=123&phone=79999999999
Отримання списку всіх груп:

https://smsc.ua/sys/phones.php?get_group=1&login=alex&psw=123
Додавання телефону "79999999999" в "чорний" список із блокуванням тільки масових розсилок:

https://smsc.ua/sys/phones.php?add_black=1&login=alex&psw=123&phone=79999999999&type=1
Видалення телефону "79999999999" із "чорного" списку:

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

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




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