Тарифи  Послуги  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-повідомлення

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

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

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

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

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

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

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

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

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

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

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

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

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

РІЗНЕ

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

Перелік доступних операцій

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

Створення субклієнта: https://smsc.ua/sys/users.php?add=1&login=<login>&psw=<password>&user=<user>&password=<password2>
Зміна налаштувань субклієнта: https://smsc.ua/sys/users.php?chg=1&login=<login>&psw=<password>&user=<user>&fio=<fio>
Зміна балансу субклієнта: https://smsc.ua/sys/users.php?pay=1&login=<login>&psw=<password>&user=<user>&sum=<sum>
Отримання статистики по субклієнтах із незалежним балансом: https://smsc.ua/sys/users.php?get_stat=1&login=<login>&psw=<password>&start=<date1>&end=<date2>&reseller=1
Отримання статистики по одному субклієнту: https://smsc.ua/sys/users.php?get_stat=1&login=<login>&psw=<password>&start=<date1>&end=<date2>&user=<sub_login>
або: https://smsc.ua/sys/users.php?get_stat=1&login=<login>&psw=<password>&start=<date1>&end=<date2>&user_id=<id>
Отримання детальної статистики по субклієнтам з незалежним балансом: https://smsc.ua/sys/users.php?get_stat_all=1&login=<login>&psw=<password>&start=<date1>&end=<date2>&reseller=1

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

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
userЛогін субклієнта.
pswcПоточний пароль субклієнта.
passwordНовий пароль субклієнта. Довжина повинна бути не менше 8 символів, і виконуватися 3 з умов: букви, цифри, різний регістр, символи.
sumСума, що перераховується клієнту з головного аккаунта у валюті головного аккаунта.
balance2Прапор, який встановлює можливість використання електронного балансу для зарахувань, списань і отримання статистики за повідомленнями.
site_idID сайту, якому належатиме створюваний субклієнт.
new_loginНовий логін субклієнта при зміні.
typeТип облікового запису.
0 (за замовчуванням) – незалежні тариф і баланс.
1 – тариф головного аккаунта, незалежний баланс.
2 – тариф і баланс головного аккаунта.
3 – баланс головного аккаунта, незалежний тариф.
4 – додатковий логін головного аккаунта.
emailОсновна адреса електронної пошти.
fl[9]Прапор, який встановлює можливість пересилки вхідних SMS на e-mail.
email2Альтернативну адресу електронної пошти для пересилання вхідних SMS.
phoneОсновний номер телефону.
fl[8]Прапор, який встановлює можливість пересилки вхідних SMS на телефон.
phone2Альтернативний номер телефону для пересилання вхідних SMS.
startПочаткова дата в періоді, за який запитується статистика. Формат: 'дд.мм. рррр'.
endКінцева дата в періоді. Якщо не вказана, то повертаються дані з початкової дати. Формат: 'дд.мм. рррр'.
user_idІдентифікатор субклієнта, який призначається сервером автоматично при створенні.
resellerТипи субклієнтів.
0 або відсутній-субклієнти, що використовують баланс головного аккаунта.
1 – субклієнти із незалежним балансом.
hide_deletedПриховати статистику по віддалених субклієнтах.
0 або відсутній-вивести статистику по всіх субклієнтах.
1 – приховати статистику по віддалених субклієнтах.
mycurПрапор, що дозволяє виводити статистику у валюті головного аккаунта.
fioІніціали (прізвище, ім'я, по батькові) або назва компанії.
propsПоле" інші реквізити " субклієнта.
cntrНомер договору.
tariffПоточний тарифний план. Субклієнту можна встановити тарифний план не вище тарифного плану Клієнта. Параметр може приймати такі значення:
0 (за замовчуванням) – 1 тариф (від 1 р.).
1 – 2 тариф (від 1000 р.).
...
8 – 9 тариф (від 100000 р.).
mintrfМінімальний тариф. Визначає мінімальне значення тарифу субклієнта незалежно від суми платежу.
currВалюта розрахунків субклієнта. Використовується в командах add и chg. Може приймати наступні основні значення:
1 – російський рубль;
2 – долар США;
3 – євро;
4 – українська гривня;
5 – казахстанський тенге.
tzЧасовий пояс. За замовчуванням встановлюється часовий пояс Клієнта. Можливі значення:
0 – GMT-12.
...
12 – GMT+00
...
24 – GMT+12.
senderІм'я відправника (Sender ID) за замовчуванням.
sender2Резервне ім'я відправника.
fl[29]Прапор, який визначає можливість використання списку відправників Клієнта (головного аккаунту).
fl2[9]Прапор, який дозволяє використання більш дорогих маршрутів для гарантованої доставки повідомлень.
fl2[24]Прапор, що дозволяє відправляти спочатку через дешеві маршрути, при недоставці повторювати через дорогі (окрім масових розсилок).
fl2[12]Прапор забороняє відправку повідомлень із автоматичною заміною імені відправника.
fl2[13] Прапор відключає додавання імені відправника в текст повідомлень без подорожчання в разі автозаміни.
nbБаланс для повідомлень. При досягненні зазначеної суми будуть відправлятися повідомлення на e-mail субклієнта.
ktmЦей параметр встановлює кількість днів для зберігання відправлених повідомлень, після закінчення яких SMS-повідомлення будуть автоматично видалятися з історії.
fmtsСписок телефонних кодів, за якими дозволена відправка повідомлень.
notesКоментарі головного облікового запису. Недоступні субклієнту.
fl2[23]Заборона масових і рекламних розсилок.
fl[26]Дозвіл використання списку контактів головного аккаунта.
fl2[8]Прапор, що встановлює розширений режим особистого кабінету.
fl[16]Включити розпізнавання автовідповідачів при дзвінках.
fl2[31]Дозволити використання шаблонів головного облікового запису.
Додаткові параметри для налаштування доступу до сервісу
fl3[20]Прапор, що дозволяє відключити підтвердження доступу з нових IP-адрес при вході.
phСписок телефонів або номерів груп через кому для виконання розсилок по SMS-командах.
fl[27]Заборонити зміни налаштувань субклієнтом.
fl[28]Заборонити оплати субаккаунтом.
fl[6]Заборонити розсилки.
fl2[1]Приховати повідомлення для субклієнта.
fl2[10]Заблокувати субаккаунт.
Додаткові параметри для лімітів і обмежень
dlimЗагальний ліміт SMS за день. Визначає максимальну кількість відправлених за добу повідомлень.
plimЛіміт на один номер. Встановлює максимальну кількість повідомлень, відправляються за добу, на один номер телефону.
tlimЛіміт на номер і текст. Встановлює максимальну кількість повідомлень, що відправляються за добу, з одним текстом на один номер телефону.
ilimЛіміт з однієї IP-адреси. Задає максимальну кількість повідомлень, що відправляються за добу, з однієї IP-адреси.
tmlimДіапазон часу в годиннику h1-h2, в який дозволено відправляти повідомлення. Якщо поточний час менше h1, то SMS-повідомлення буде відправлено абоненту при настанні часу h1, якщо поточний час потрапляє в проміжок від h1 до h2, то повідомлення буде відправлено негайно, в іншому випадку відправка буде виконана на наступний день при досягненні часу h1. Ця функція, наприклад, корисна для того, щоб не допустити отримання SMS-повідомлень абонентами в нічний час.
fl2[15]Заборонити відправку в інший час, окрім зазначеного в параметрі tmlim, замість перенесення на наступний день.
fl2[16]При використанні параметра tmlim враховувати часовий пояс абонентів.
vldМаксимальний строк доставки повідомлень тимчасово недоступним абонентам (хв.).
Додаткові параметри для автовідповідачів
answАвтовідповідь на вхідні SMS.
answ_callАвтовідповідь на вхідні дзвінки.
fl2[4]Відключити пересилку дзвінків (на e-mail, телефон і обробник).
Додаткові параметри для налаштувань API
urlhttp-адреса (URL) скрипта для обробки статусів доставки SMS-повідомлень і (або) вхідних SMS-повідомлень на стороні субклієнта. Зазначений скрипт буде викликатись Сервером після кожного отримання статусу доставки раніше відправленого субклієнтом SMS-повідомлення та (або) після отримання вхідного SMS-повідомлення від абонента.
fl[10]Вмикання пересилання статусів повідомлень на http-адресу, вказану в параметрі url.
fl[11]Вмикання пересилання вхідних SMS-повідомлень на http-адресу, встановлену в параметрі url.
fl[2]Включити SMPP-доступ (попередньо необхідно зареєструвати IP-адреси через ONLINE-підтримку).
fl[1]Передавати вхідні SMS по SMPP-підключенню.
fl[23]Відслідковувати статуси окремих SMS-частин.
fl2[27]Режим тестування (віртуальна відправка без оплати).
fl[5]Включити контроль за доставкою повідомлень.
fl[30]Включення лога API. Дозволяє переглядати 20 останніх http-запитів. Зберігається 10 хвилин після останнього запиту.
Додаткові параметри для E-mail2sms
mfl[0]Прапор, що дозволяє відключити функцію e-mail2sms.
mphРозділений комою список номерів телефонів, на які будуть відправлятись повідомлення.
mfl[5]Включає можливість вказівки списку телефонів у тілі листа.
mfl[6]Включає можливість вказівки списку телефонів у адресі листа.
mfl[1]Пересилання листа без теми.
mfl[2]Пересилання листа без тексту.
mfl[3]Пересилання листа без зворотної адреси (від кого).
mfl[4]Переклад тексту листа в трансліт.
mh1Початкове значення діапазону часу для відправки вхідних листів. Разом із параметром mh2 визначає діапазон, протягом якого можливе пересилання вхідних листів у вигляді SMS-повідомлень.
mh2Кінцеве значення діапазону часу для відправки вхідних листів.
mlenМаксимальна довжина повідомлення, до якої обрізається вхідний лист при відправці у вигляді SMS-повідомлення (число більше 12 задає максимальну довжину повідомлення, менше 12 - кількість SMS).

Відповідь сервера і коди помилок

У разі помилки Сервер повертає наступний рядок:
  • 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Помилка виконання операції.
6Субклієнт з указаним іменем не існує.
7Вказано сублогін, який має загальний баланс із головним аккаунтом, або в запиті на операцію з електронним балансом не вказано параметр balance2=1.
8Помилка при збереженні запису.
9Спроба відправки більше трьох запитів на додавання субклієнтів або зміна одного і того ж субклієнта протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).
10Недостатньо коштів для зарахування.

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

При створенні субклієнта:
  • при fmt = 0: ID = <id>

  • при fmt = 1: <id>

  • при fmt = 2:
    <user
    <id>id</id>
    </user>

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

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

При зміні сублогіна:
  • при fmt = 0,1: OK

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

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


При запиті статистики:
  • при fmt = 0 та get_stat = 1:
    login = <login>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency>
    ...

  • при fmt = 0 та get_stat_all = 1:
    login = <login>, description = <description>, operator = <operator>, mccmnc = <mccmnc>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency>
    ...

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

  • при fmt = 1 та get_stat_all = 1:
    <login>,<description>,<operator>,<mccmnc>,<cnt>,<credit>,<debit>,<currency>
    ...

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

  • при fmt = 2 та get_stat_all = 1:
    <list>
    <user login="login">
    <item>
    <description>description</description>
    <operator>operator</operator>
    <mccmnc>mccmnc</mccmnc>
    <sms>cnt</sms>
    <credit>credit</credit>
    <debit>debit</debit>
    <currency>currency</currency>
    </item>
    ...
    </user>
    ...
    </list>

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

  • при fmt = 3 та get_stat_all = 1:
    [{
    "login": "<login>",
    "items": [{
    "description": "<description>",
    "operator": "<operator>",
    "mccmnc": "<mccmnc>",
    "sms": "<cnt>",
    "credit": "<credit>",
    "debit": "<debit>",
    "currency": "<currency>"
    },
    ...]
    },
    ...]

Де:
<login> - логін субклієнта.
<description> - назва операції.
<operator> - назва оператора.
<mccmnc> - числовий код країни абонента плюс числовий код оператора абонента
<cnt> - кількість повідомлень.
<credit> - витрати.
<debit> - надходження.
<currency> - трехсимвольный код валюти субклієнта.

Приклади дій із субклієнтами

Приклади:

Створення субклієнта з логіном "mylogin", паролем "mypassword", номером телефону 79999999999 і дозволом на використання імена відправників (Sender ID) головного облікового запису:

https://smsc.ua/sys/users.php?add=1&login=alex&psw=123&user=mylogin&password=mypassword&phone=79999999999&fl[29]=1
Зміна логіна субклієнта з "mylogin" на "mylogin2", типу клієнта на "Тариф і баланс головного облікового запису" і установки дозволених кодів для відправки SMS тільки по Росії:

https://smsc.ua/sys/users.php?chg=1&login=alex&psw=123&user=mylogin&password=mypassword&new_login=mylogin2&type=2&fmts=7,-77
Отримання статистики по субклієнтам, що мають загальний баланс з головним аккаунтом і SMS, відправлені з електронного балансу:

https://smsc.ua/sys/users.php?get_stat=1&login=alex&psw=123&balance2=1
Отримання статистики по субклієнту з логіном "sub_alex":

https://smsc.ua/sys/users.php?get_stat=1&login=alex&psw=123&user=sub_alex
Отримання статистики по незалежних субклієнтах у валюті головного облікового запису з "01.01.2014" за "01.02.2014":

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

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

Створення і вивантаження рахунків і актів

Для створення нового рахунку для субклієнта необхідно викликати методом GET або POST адреси: https://smsc.ua/sys/documents.php?add_account=1&login=<login>&psw=<password>&user=<user>&sum=<sum> або: https://smsc.ua/sys/documents.php?add_account=1&login=<login>&psw=<password>&user_id=<user_id>&sum=<sum>
Для завантаження існуючого рахунку субклієнта необхідно викликати методом GET або POST адреси: https://smsc.ua/sys/documents.php?get_account=1&login=<login>&psw=<password>&user=<user>&id=<id> або: https://smsc.ua/sys/documents.php?get_account=1&login=<login>&psw=<password>&user_id=<user_id>&id=<id>
Для вивантаження існуючого акту субкліента необхідно викликати методом GET або POST адрес: https://smsc.ua/sys/documents.php?get_act=1&login=<login>&psw=<password>&user=<user>&id=<id> https://smsc.ua/sys/documents.php?get_act=1&login=<login>&psw=<password>&user_id=<user_id>&id=<id> або: https://smsc.ua/sys/documents.php?get_act=1&login=<login>&psw=<password>&user=<user>&num=<num> https://smsc.ua/sys/documents.php?get_act=1&login=<login>&psw=<password>&user_id=<user_id>&num=<num>
Серверу передаються наступні параметри:

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
userЛогін субклієнта, для якого необхідно створити або вивантажити рахунок. Замість цього параметру можна використовувати параметр user_id.
user_idІдентифікатор субклієнта, для якого необхідно створити або вивантажити рахунок. Замість цього параметра можна використовувати параметрuser.
sumСума, на яку необхідно створити рахунок у валюті клієнта.
serviceНазва послуги, вказаної при створенні рахунку.
idІдентифікатор запитуваного рахунку або акту.
numНомер запитуваного акту.

У разі помилки Сервер повертає наступний рядок:
    {
    "error": "опис",
    "error_code": N
    }
N – номер помилки, може приймати наступні значення:

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

У разі успішного запиту на створення рахунку Сервер повертає multipart-структуру, що включає в себе 2 частини з відповідними заголовками. Перша частина містить відповідь Сервера в json-форматі, що містить ідентифікатор і суму створеного рахунку, друга частина включає в себе файл із рахунком в pdf-форматі.

У разі успішного запиту на отримання рахунку Сервер повертає файл з рахунком в pdf-форматі.

У разі успішного запиту на отримання акту Сервер повертає файл з актом в pdf-форматі.

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




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