Тарифи	Послуги	API	Партнерам	Про сервіс	Контакти

^{Безкоштовно по Україні}

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

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

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

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

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

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

Приклади надсилання повідомлень

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

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

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

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

Приклади відправки e-mail повідомлень

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

Використання голосового меню (IVR)

Приклади відправки голосових повідомлень

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

Передача файлів

Додавання кнопки

Типи повідомлень

Приклади відправки viber-повідомлень

Відправлення повідомлення в Telegram

Приклади відправки повідомлень в Telegram

Відправлення повідомлення в чат-бот Telegram

Приклади відправки повідомлень в чат-бот Telegram

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

Приклади відправки повідомлень в Whatsapp

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

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

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

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

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

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

Дії з розсилками

Розсилання. Відповідь сервера та коди помилок

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

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

Перевірка статусу

Статуси повідомлень. Відповідь сервера та коди помилок

Коди статусів

Коди помилок у статусі

Видалення повідомлення

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

Запит балансу

Баланс. Відповідь сервера та коди помилок

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

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

Контакти та групи. Опис параметрів

Контакти та групи. Відповідь сервера та коди помилок

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

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

Робота із субклієнтами

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

Субклієнти. Опис параметрів

Відповідь сервера і коди помилок (субклієнти)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

РІЗНЕ

Підключення виділених номерів для прийому повідомлень

Передача статусів і повідомлень на обробник Клієнта

Підключення антиспам перевірки (captcha) до сайту

Підтвердження номеру телефону за допомогою дзвінка

Дії з відкладеними завданнями

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

У разі помилки Сервер повертає наступний рядок:

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:
<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_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:
{
"sender": <id>
}

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

При зміні імені відправника, відправці коду, підтвердженні та видаленні імені відправника:

при fmt = 0, 1: OK
при fmt = 2:
<result>OK</result>
при fmt = 3:

{
"result": "OK"
}

Увійти через:


Запам'ятати для автовходу



Реєстрація	Забули пароль?