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

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

РІЗНЕ

Керування іменами відправників (Sender ID)

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

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

Для отримання списку зареєстрований в особистому кабінеті і допущених модератором імен відправників: https://smsc.ua/sys/senders.php?get=1&login=<login>&psw=<password>
Щоб додати нове ім'я відправника: https://smsc.ua/sys/senders.php?add=1&login=<login>&psw=<password>&sender=<sender>&cmt=<cmt>
Щоб змінити ім'я відправника: https://smsc.ua/sys/senders.php?chg=1&login=<login>&psw=<password>&sender=<sender>&cmt=<cmt> або https://smsc.ua/sys/senders.php?chg=1&login=<login>&psw=<password>&id=<id>&cmt=<cmt>
Надсилання коду підтвердження для цифрового імені відправника: https://smsc.ua/sys/senders.php?send_code=1&login=<login>&psw=<password>&sender=<sender>
Підтвердження цифрового імені відправника: https://smsc.ua/sys/senders.php?check_code=1&login=<login>&psw=<password>&sender=<sender>&code=<code>
Щоб видалити ім'я відправника: https://smsc.ua/sys/senders.php?del=1&login=<login>&psw=<password>&sender=<sender> або https://smsc.ua/sys/senders.php?del=1&login=<login>&psw=<password>&id=<id>
При додаванні або зміні імені відправника в тілі запиту можна передавати файл документа для операторів (свідоцтво на товарний знак, сертифікат на домен) у форматі jpg, tif, pdf, png, zip, rar. Коментар до документа може бути вказаний у додатковому параметрі doc_info.

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

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

ПараметрЗначення
loginЛогін Клієнта.
pswПароль Клієнта (можна додати або редагувати на даннійсторінці).
all0 (за замовчуванням) – отримати список активованих імен відправників.
1 – отримати повний список імен відправників.
senderСтворюване або видаляється ім'я відправника.
mega1 – зареєструвати ім'я у оператора Мегафон за тарифом з безкоштовними іменами.
mts1 – зареєструвати ім'я у оператора MTS.
mts_step1 – зареєструвати платне ім'я у оператора MTS.
tele21 – зареєструвати ім'я у оператора Tele2 за тарифом з безкоштовними іменами.
mega_step1 – зареєструвати платне ім'я у оператора Мегафон.
bee_step1 – зареєструвати платне ім'я у оператора Білайн.
motiv_step1 – зареєструвати платне ім'я у оператора MOTIV.
tele2_step1 – зареєструвати платне ім'я у оператора Tele2.
ua_reg1 – зареєструвати ім'я для України на знижений тариф за національним трафіком.
Для даного тарифу необхідно додатково передати наступні параметри:
fio – юридична назва організації (ТОВ / СПД).
inn – ЄДРПОУ / ІПН.
site – Адреса сайту (необов'язковий параметр).
email – E-mail для зв'язку.
address – Фактична адреса.
desc – Опис послуг, що надаються відправником.
subj – Тема (мета інформування).
ua_int1 – зареєструвати ім'я для України за вищим тарифом для міжнародного трафіку.
idІдентифікатор імені відправника, який призначається Сервером автоматично при створенні нового імені.
cmtКоментар, що вказується при створенні імені відправника.
mail1 – додати e-mail адресу відправника.
nameКоментар, пов'язаний із параметромmail (зазвичай ім'я власника e-mail адреси).
codeКод для підтвердження цифрового імені відправника.
siteАдреса сайту, від якого будуть приходити коди для підтвердження цифрових імен відправників. Даний параметр повинен бути раніше доданий і активований в якості Sender ID. Якщо не вказано, то повідомлення будуть приходити від імені відправника за замовчуванням.
site_nameАдреса сайту, що вказується в тексті повідомлення з кодом підтвердження.
userЛогін субклієнта, до якої застосовується вказана команда.
operators1 – додати у відповідь код статусу імені відправника у оператора.
from_dateВибрати імена відправників починаючи з зазначеної дати, для яких був змінений статус імені у будь-якого з операторів. При вказівці даного параметра відбувається сортування Імен в порядку убування дати зміни статусів імен. Формат DD.MM.YYYY.
prev_idУнікальний ідентифікатор імені відправника, який призначається сервером автоматично при створенні імені. Використовується для запиту списку імен, створених до імені із зазначеним ідентифікатором.
cntКількість імен відправників, що повертаються при запиті списку імен. Максимальне значення становить 15000.
doc_infoЯкщо при створенні або зміні імені відправника в тілі запиту буде переданий файл документа для операторів, то в даному параметрі можна вказати опис до переданого файлу.
charsetКодування переданих параметрів.

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

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

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

При запиті списку імен відправників:
  • при fmt = 0 та all = 0:
    name = <sender>, id = <id>
    ...

  • при fmt = 1 та all = 0:
    <sender>,<id>
    ...

  • при fmt = 2 та all = 0:
    <list>
    <sender id="<id>">sender</sender>
    ...
    </list>

  • при fmt = 3 та all = 0:
    [{
    "sender": "<sender>",
    "id": <id>
    },
    ...]

  • при fmt = 0 та all = 1:
    name = <sender>, status = <status>, id = <id>
    ...

  • при fmt = 1 та all = 1:
    <sender>,<status>,<id>
    ...

  • при fmt = 2 та all = 1:
    <list>
    <sender status="<status>" id="<id>">sender</sender>
    ...
    </list>

  • при fmt = 3 та all = 1:
    [{
    "sender": "<sender>",
    "status": <status>,
    "id": <id>
    },
    ...]

  • при fmt = 0 и operators = 1:
    name = <sender>, mega = <mega_status>, mts = <mts_status>, mega_step = <mega_step_status>, bee_step = <bee_step_status>, motiv_step = <motiv_step_status>, mts_step = <mts_step_status>, tele2_step = <tele2_step_status>, tele2 = <tele2_status>, ua_reg = <ua_reg_status>, ua_int = <ua_int_status>, id = <id>
    ...

  • при fmt = 1 и operators = 1:
    <sender>,<mega_status>,<mts_status>,<mega_step_status>,<bee_step_status>,<motiv_step_status>,<mts_step_status>,<tele2_step_status>, <tele2_status>,<ua_reg_status>,<ua_int_status>,<id>
    ...

  • при fmt = 2 и operators = 1:
    <list>
    <sender mega="<mega_status>" mts="<mts_status>" mega_step="<mega_step_status>" bee_step="<bee_step_status>" motiv_step="<motiv_step_status>" mts_step="<mts_step_status>" tele2_step="<tele2_step_status>" tele2="<tele2_status>" ua_reg="<ua_reg_status>" ua_int="<ua_int_status>" id="<id>">sender</sender>
    ...
    </list>

  • при fmt = 3 и operators = 1:
    [{
    "sender": "<sender>",
    "mega": "<mega_status>",
    "mts": "<mts_status>",
    "mega_step": "<mega_step_status>",
    "bee_step": "<bee_step_status>",
    "motiv_step": "<motiv_step_status>",
    "mts_step": "<mts_step_status>",
    "tele2_step": "<tele2_step_status>",
    "tele2": "<tele2_status>",
    "ua_reg": "<ua_reg_status>",
    "ua_int": "<ua_int_status>",
    "id": "<id>"
    },
    ...]

Де:
<sender> – зареєстроване та допущене до використання ім'я відправника.
<mega_status>, <mts_status>(до 01.12.2017), <mega_step_status>, <bee_step_status>, <motiv_step_status>, <mts_step_status>(c 01.12.2017), <tele2_step_status>, <tele2_status>, <ua_reg_status>, <ua_int_status> – код статусу імені відправника у відповідного оператора (0 - очікує реєстрації, 1 - відправлене на реєстрацію, 2 - допущене оператором, 3 - не прийняте оператором, 4 - тимчасово відключене, 5 - недостатньо коштів на рахунку, 6 - дубль іншого імені (конфлікт), 8 - необхідні підтверджуючі документи).
<status> – статус імені відправника (0-очікує модерації, 1-допущено до використання, 2-вимкнено).
<id> – унікальний ідентифікатор імені відправника (призначається Сервером автоматично при створенні імені).

Якщо для будь-якого оператора ім'я відправника має замінюючий аналог, то при operators = 1 и fmt = 0,2,3 у відповідь сервера додатково буде включена дана заміна.

При додаванні нового імені відправника:
  • при fmt = 0: ID = <id>

  • при fmt = 1: <id>

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

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

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

При зміні імені відправника, відправці коду, підтвердженні та видаленні імені відправника:
  • при fmt = 0, 1: OK

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

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


Приклади дій з іменами відправників

Приклади:

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

https://smsc.ua/sys/senders.php?get=1&login=alex&psw=123
Додавання нового імені відправника:

https://smsc.ua/sys/senders.php?add=1&login=alex&psw=123&sender=my_shop&cmt=test
Надсилання коду підтвердження для цифрового імені відправника:

https://smsc.ua/sys/senders.php?send_code=1&login=alex&psw=123&sender=79999999999
Відправка коду підтвердження цифрового імені відправника для субклієнта "subalex" від імені "mysite.ru":

https://smsc.ua/sys/senders.php?send_code=1&login=alex&psw=123&sender=79999999999&user=subalex&site=mysite.ru
Підтвердження цифрового імені відправника:

https://smsc.ua/sys/senders.php?check_code=1&login=alex&psw=123&sender=79999999999&code=338824
Видалення імені відправника:

https://smsc.ua/sys/senders.php?del=1&login=alex&psw=123&sender=my_shop

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




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