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

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

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

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

Сервер відправляє відповідь у вигляді рядка:

Якщо сталася помилка, то відповідь буде однією із наступних:

При fmt = 0:

ERROR = N (описание) – для помилок 1,2,3,4,5,9.

При fmt = 1:

0,-N - для помилок 1,2,3,4,5,9.

При fmt = 2:

Для помилок 1,2,3,4,5,9:
<result>
<error>опис</error>
<error_code>N</error_code>
</result>

При fmt = 3:

Для помилок 1,2,3,4,5,9:
{
"error": "опис",
"error_code": N
}

N – номер помилки, може приймати наступні значення:

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

У разі успішної обробки запиту повертається рядок наступного виду:

При створенні розсилки:

при cost = 0 і fmt = 0: OK, ID - <id>
при cost = 1 і fmt = 0: OK, ID - <id>, COST - <cost>
при cost = 0 і fmt = 1: <id>
при cost = 1 і fmt = 1: <id>,<cost>
при cost = 0 і fmt = 2:
<result>
<id>id</id>
</result>
при cost = 1 і fmt = 2:
<result>
<id>id</id>
<cost>cost</cost>
</result>
при cost = 0 і fmt = 3:
{
"id": <id>
}
при cost = 1 і fmt = 3:
{
"id": <id>,
"cost": "<cost>"
}

При відключенні або видаленні розсилки:

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

При отриманні інформації про конкретну розсилку (при mail=1 параметр "phones" змінюється на "emails"):

при fmt = 0: <id>|<name>|<subject>|<repeat_send>|<repeat_cnt>|<created>|<changed>|<need_date>|<last_sent>|<phones>|<message>|<format>|<validity>|<period>|<frequency>|<status>|<sender_id>
при fmt = 1: <id>;<name>;<subject>;<repeat_send>;<repeat_cnt>;<created>;<changed>;<need_date>;<last_sent>;<phones>;<message>;<format>;<validity>;<period>;<frequency>;<status>;<sender_id>

при fmt = 2:

<job>
<id>id</id>
<name>name</name>
<subject>subject</subject>
<repeat_send>repeat_send</repeat_send>
<repeat_cnt>repeat_cnt</repeat_cnt>
<created>created</created>
<changed>changed</changed>
<need_date>need_date</need_date>
<last_sent>last_sent</last_sent>
<phones>phones</phones>
<message>message</message>
<format>format</format>
<validity>validity</validity>
<period>period</period>
<frequency>frequency</frequency>
<status>status</status>
<sender_id>sender_id</sender_id>
</job>

при fmt = 3:

[
{
"id": <id>,
"name": "<name>",
"subject": "<subject>",
"repeat_send": <repeat_send>,
"repeat_cnt": <repeat_cnt>,
"created": "<created>",
"changed": "<changed>",
"need_date": "<need_date>",
"last_sent": "<last_sent>",
"phones": "<phones>",
"message": "<message>",
"format": <format>,
"validity": <validity>,
"period": "<period>",
"frequency": <frequency>,
"status": <status>,
"cost": "<cost>",
"sms_sent": <sms_sent>,
"sms_ok": <sms_ok>,
"sender_id": "<sender_id>"
}
]

При отриманні списку розсилок (при mail=1 параметр "phones" змінюється на "emails"):

при fmt = 0: <id>|<name>|<changed>|<need_date>|<last_sent>|<phones>|<message>|<phones_cnt>|<cost>|<status>|<sender_id>|<format>
при fmt = 1: <id>;<name>;<changed>;<need_date>;<last_sent>;<phones>;<message>;<phones_cnt>;<cost>;<status>;<sender_id>;<format>

при fmt = 2:

<sms_jobs>
<job>
<id>id</id>
<name>name</name>
<changed>changed</changed>
<need_date>need_date</need_date>
<last_sent>last_sent</last_sent>
<phones>phones</phones>
<message>message</message>
<phones_cnt>phones_cnt</phones_cnt>
<cost>cost</cost>
<status>status</status>
<sender_id>sender_id</sender_id>
<format>format</format>
</job>
...
</sms_jobs>

при fmt = 3:

[
{
"id": <id>,
"name": "<name>",
"changed": "<changed>",
"need_date": "<need_date>",
"last_sent": "<last_sent>",
"phones": "<phones>",
"message": "<message>",
"phones_cnt": <phones_cnt>,
"cost": "<cost>",
"status": <status>,
"sender_id": "<sender_id>",
"format": <format>,
"sms_sent": <sms_sent>,
"sms_ok": <sms_ok>
},
...
]

Де:
<id> – ідентифікатор розсилки, переданий клієнтом або призначений Сервером автоматично.
<name> – назва розсилки.
<subject> – тема (для e-mail розсилок).
<repeat_send> – період повтору.
<repeat_cnt> – кількість повторів розсилки.
<created> – дата створення розсилки.
<changed> – дата зміни розсилки.
<need_date> – призначена дата відправки.
<last_sent> – дата останньої відправки.
<phones> (<emails>) – список телефонів (e-mail адрес) одержувачів повідомлень.
<message> – текст повідомлення.
<format> – формат повідомлення.
<validity> – "час життя" повідомлення.
<period> – інтервал відправки повідомлень.
<frequency> – частота відправки повідомлень.
<status> – статус розсилки.
<sender_id> – ім'я відправника.
<phones_cnt> – кількість одержувачів.
<cost> – вартість розсилки.
<sms_sent> – кількість відправлених повідомлень.
<sms_ok> – кількість доставлених повідомлень.

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


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



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