| Керування іменами відправників (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. Максимальний розмір переданого файлу не повинен перевищувати 3 Мб. Коментар до документа може бути вказаний в додатковому параметрі doc_info.
Опис параметрів
Опис параметрів, що передаються Серверу:
Параметр | Значення
|
---|
login | Логін Клієнта.
|
---|
psw | Пароль Клієнта (можна додати або редагувати на даннійсторінці).
|
---|
all | 0 (за замовчуванням) – отримати список активованих імен відправників.
1 – отримати повний список імен відправників.
|
---|
sender | Створюване або те, що видаляється, ім'я відправника.
|
---|
mts_step | 1 – зареєструвати платне ім'я у оператора MTS.
|
---|
sber_step | 1 – зареєструвати безкоштовне ім'я у оператора СберМобайл.
|
---|
tele2 | 1 – зареєструвати ім'я у оператора Tele2 за тарифом із безкоштовними іменами.
|
---|
motiv | 1 – зареєструвати ім'я у оператора МОТИВ за тарифом з безкоштовними іменами.
|
---|
mega_step | 1 – зареєструвати платне ім'я у оператора Мегафон.
|
---|
bee_step | 1 – зареєструвати платне ім'я у оператора Білайн.
|
---|
motiv_step | 1 – зареєструвати платне ім'я у оператора MOTIV.
|
---|
winmob_step | 1 – зареєструвати платне ім'я у оператора Win-Mobile.
|
---|
volnamob_step | 1 – зареєструвати платне ім'я у оператора хвиля мобайл.
|
---|
tele2_step | 1 – зареєструвати платне ім'я у оператора Tele2.
|
---|
ua_reg | 1 – зареєструвати ім'я для України на знижений тариф за національним трафіком.
Для даного тарифу необхідно додатково передати наступні параметри:
fio – Юридична назва організації (ТОВ / СПД).
inn – ЄДРПОУ / ІПН.
site – Адреса сайту або посилання на соц. мережа.
email – E-mail для зв'язку.
address – Фактична адреса.
desc – Опис послуг, що надаються відправником.
subj – Тема (мета інформування).
|
---|
ua_int | 1 – зареєструвати ім'я для України за більш високим тарифом для міжнародного трафіку. Для реєстрації також необхідно додатково передати поля, описані вище для параметра ua_reg.
|
---|
by_reg | 1 – зареєструвати ім'я для Білорусі на знижений тариф по національному трафіку.
Для даного тарифу необхідно додатково передати наступні параметри:
by_fio – Назва компанії.
by_inn – УНП / ІПН.
by_address – Адреса компанії.
by_ocup - Сфера діяльності (варіанти можна уточнити на даний сторінка). Нумерація від 1 до 19.
by_type - Тип розсилки (варіанти можна уточнити на даний сторінка). Нумерація від 1 до 3.
by_mes – Приклад повідомлення.
by_site – Адреса сайту.
|
---|
by_int | 1 – зареєструвати ім'я для Білорусі за більш високим тарифом для міжнародного трафіку. Для реєстрації також необхідно додатково передати поля, описані вище для параметра by_reg.
|
---|
id | Ідентифікатор імені відправника, який призначається Сервером
автоматично при створенні нового імені.
|
---|
cmt | Коментар, що вказується при створенні імені відправника.
|
---|
mail | 1 – додати e-mail адресу відправника.
|
---|
name | Коментар, пов'язаний із параметромmail (зазвичай ім'я власника e-mail адреси).
|
---|
code | Код для підтвердження цифрового імені відправника.
|
---|
site | Адреса сайту, від якого будуть приходити коди для підтвердження цифрових
імен відправників. Даний параметр повинен бути раніше доданий і активований в якості
Sender ID. Якщо не вказане, то повідомлення будуть приходити від імені відправника
за замовчуванням.
|
---|
site_name | Адреса сайту, що вказується в тексті повідомлення з кодом підтвердження.
|
---|
user | Логін субклієнта, до якої застосовується вказана команда.
|
---|
operators | 1 – додати у відповідь код статусу імені відправника у оператора.
|
---|
from_date | Вибрати імена відправників починаючи із зазначеної дати, для яких був змінений статус імені у будь-якого з операторів.
При вказівці даного параметра відбувається сортування імен у порядку убування дати зміни статусів імен. Формат DD.MM.YYYY.
|
---|
prev_id | Унікальний ідентифікатор імені відправника, який призначається сервером автоматично при створенні імені. Використовується для запиту списку імен, створених до імені із зазначеним ідентифікатором.
|
---|
cnt | Кількість імен відправників, що повертаються при запиті списку імен. Максимальне значення становить 15000.
|
---|
doc_info | Якщо при створенні або зміні імені відправника в тілі запиту буде переданий файл документа для операторів, то в даному параметрі можна вказати опис до переданого файлу.
|
---|
charset | Кодування параметрів, що передаються.
|
---|
files | 1 – повернути у відповіді сервера для команди get масив files, що містить інформацію про прикріплені файли документів для операторів. Параметр актуальний тільки для форматів fmt=2 або fmt=3.
Масив включає наступні поля:
file – Назва файлу.
fid – Ідентифікатор файлу в системі.
fstatus – Статус файлу (0 - на перевірці, 1 - відхилено, 2-допущено).
fcomment – Коментар адміністратора.
|
---|
Відповідь сервера і коди помилок
У разі помилки Сервер повертає наступний рядок:
- 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 | Ім'я відправника не знайдене.
|
---|
4 | IP-адреса тимчасово заблокована.
|
---|
5 | Помилка збереження або видалення імені відправника.
|
---|
7 | Неправильний формат номеру.
|
---|
8 | Код підтвердження на вказаний номер не може бути доставлений.
|
---|
9 | Спроба відправки більше трьох однакових запитів на отримання списку доступних імен відправників
або п'яти запитів на створення нового імені відправника протягом хвилини.
Дана помилка виникає також при спробі відправки п'ятнадцяти і більше запитів одночасно з різних підключень під одним логіном (too many concurrent requests).
|
---|
10 | Код вже був відправлений на вказаний номер. Повторна спроба можлива через 8 годин.
|
---|
11 | Невірний код підтвердження.
|
---|
У разі успішного запиту Сервер повертає відповідь у вигляді рядка.
При запиті списку імен відправників:
- при fmt = 0 та all = 0:
name = <sender>, id = <id>
... |
- при fmt = 1 та all = 0:
- при 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_step = <mega_step_status>, bee_step = <bee_step_status>, motiv_step = <motiv_step_status>, sber_step = <sber_step_status>, winmob_step = <winmob_step>, volnamob_step = <volnamob_step>, mts_step = <mts_step_status>, tele2_step = <tele2_step_status>, tele2 = <tele2_status>, ua_reg = <ua_reg_status>, ua_int = <ua_int_status>, mega_int = <mega_int_status>, motiv_int = <motiv_int_status>, mts_int = <mts_int_status>, motiv = <motiv_status>, by_reg = <by_reg_status>, by_int = <by_int_status>, tele2_int = <tele2_int_status>, sber_int = <sber_int_status>, id = <id>
... |
- при fmt = 2 и operators = 1:
<list>
<sender mega_step="<mega_step_status>" bee_step="<bee_step_status>" motiv_step="<motiv_step_status>" sber_step="<sber_step_status>" winmob_step="<winmob_step_status>" volnamob_step="<volnamob_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>" mega_int="<mega_int_status>" motiv_int="<motiv_int_status>" mts_int="<mts_int_status>" motiv="<motiv_status>" by_reg="<by_reg_status>" by_int="<by_int_status>" tele2_int="<tele2_int_status>" sber_int="<sber_int_status>" id="<id>">sender</sender>
...
</list>
|
- при fmt = 3 и operators = 1:
[{
"sender": "<sender>",
"mega_step": "<mega_step_status>",
"mega_int": "<mega_int_status>",
"bee_step": "<bee_step_status>",
"motiv": "<motiv_status>",
"motiv_step": "<motiv_step_status>",
"motiv_int": "<motiv_int_status>",
"sber_step": "<sber_step_status>",
"sber_int": "<sber_int_status>",
"winmob_step": "<winmob_step_status>",
"volnamob_step": "<volnamob_step_status>",
"mts_step": "<mts_step_status>",
"mts_int": "<mts_int_status>",
"tele2_step": "<tele2_step_status>",
"tele2": "<tele2_status>",
"tele2_int": "<tele2_int_status>",
"ua_reg": "<ua_reg_status>",
"ua_int": "<ua_int_status>",
"by_reg": "<by_reg_status>",
"by_int": "<by_int_status>",
"id": "<id>"
},
...] |
Де:
<sender> – зареєстроване та допущене до використання ім'я відправника.
<mega_step_status>, <mega_int_status>, <bee_step_status>, <motiv_status>, <motiv_step_status>, <motiv_int_status>, <sber_step_status>, <sber_int_status>, <winmob_step_status>, <volnamob_step_status>, <mts_step_status>, <mts_int_status>, <tele2_step_status>, <tele2_status>, <tele2_int_status>, <ua_reg_status>, <ua_int_status>, <by_reg_status>, <by_int_status> - код статусу імені відправника у відповідного оператора (0-очікує реєстрації, 1-відправлено на реєстрацію, 2-допущено оператором, 3-не прийнято оператором, 4-тимчасово відключено, 5-недостатньо коштів на рахунку, 8-необхідні підтверджуючі документи, 9-активація з початку місяця), 255-допущено, але позначено на зняття з реєстрації).
<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:
Де:
<id> – ідентифікатор імені відправника, призначений Сервером автоматично.
При зміні імені відправника, відправці коду, підтвердженні та видаленні імені відправника:
- при fmt = 0, 1: OK
- при fmt = 2:
<result>OK</result>
- при fmt = 3:
Приклади дій з іменами відправниківПриклади:
Отримання списку імен відправників:
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
Сервер не приймає більше трьох однакових запитів протягом хвилини на отримання списку доступних імен
відправників і п'яти запитів на створення нового імені відправника для зниження навантаження і захисту від помилок і зациклень
у програмі на стороні клієнта.
|