Тарифи	Послуги	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,4,5,9;
ERROR = N (опис), ID - <id сообщения> – для помилок 3,6,7,8.

При fmt = 1:

0,-N - для помилок 1,2,4,5,9;
<id сообщения>,-N – для помилок 3,6,7,8.

При fmt = 2:

Для помилок 1,2,4,5,9:

<result>
<error>опис</error>
<error_code>N</error_code>
</result>
Для помилок 3,6,7,8:
<result>
<error>опис</error>
<error_code>N</error_code>
<id>id сообщения</id>
</result>

При fmt = 3:

Для помилок 1,2,4,5,9:
{
"error": "опис",
"error_code": N
}
Для помилок 3,6,7,8:
{
"error": "опис",
"error_code": N,
"id": <id сообщения>
}

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

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

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

при cost = 0 і fmt = 0: OK - <n> SMS, ID - <id>
при cost = 1 і fmt = 0: <cost> (<n> SMS)
при cost = 2 і fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>
при cost = 3 і fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>, BALANCE - <balance>
при cost = 0 і fmt = 1: <id>,<n>
при cost = 1 і fmt = 1: <cost>,<n>
при cost = 2 і fmt = 1: <id>,<n>,<cost>
при cost = 3 і fmt = 1: <id>,<n>,<cost>,<balance>
при cost = 0 і fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
</result>
при cost = 1 і fmt = 2:
<result>
<cost>cost</cost>
<cnt>n</cnt>
</result>
при cost = 2 і fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
<cost>cost</cost>
</result>
при cost = 3 і fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
<cost>cost</cost>
<balance>balance</balance>
</result>
при cost = 0 і fmt = 3:
{
"id": <id>,
"cnt": <n>
}
при cost = 1 і fmt = 3:
{
"cost": "<cost>",
"cnt": <n>
}
при cost = 2 і fmt = 3:
{
"id": <id>,
"cnt": <n>,
"cost": "<cost>"
}
при cost = 3 і fmt = 3:
{
"id": <id>,
"cnt": <n>,
"cost": "<cost>",
"balance": "<balance>"
}
при op = 1 і fmt = 0 або 1, інформація додається в кінець звичайного виводу з нового рядка:
<phone>,<mccmnc>,<cost>,<status>,<error>
при op = 1 та fmt = 2, у відповідь додається масив:
<phones>
<phone mccmnc="mccmnc" cost="cost" status="status" error="error">phone</phone>
...
</phones>
при op = 1 та fmt = 3, у відповідь додається масив:
"phones": [{
"phone": "<phone>",
"mccmnc": "<mccmnc>",
"cost": "<cost>",
"status": "<status>",
"error": "<error>"
},
...
]

Де:
<n> - це кількість відправлених SMS, обчислюється як кількість SMS в повідомленні, помножене на кількість одержувач.
<id> – ідентифікатор повідомлення, переданий Клієнтом або призначений Сервером автоматично.
<cnt> – кількість частин (при відправці SMS-повідомлення) або кількість секунд (при голосовому повідомленні (дзвінку)).
<balance> – новий баланс Клієнта.
<phone> – номер телефону.
<mccmnc> – числовий код країни абонента плюс числовий код оператора абонента.
<cost> – вартість SMS-повідомлення.
<status> – код статусу SMS-повідомлення.
<error> – код помилки в статусі.

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

Сервер також блокує надсилання більше 50 повідомлень одному абоненту, які були відправлені з перервою між повідомленнями менше 60-ти секунд, для захисту від флуду і зайвого списання коштів із рахунку клієнта, так як багато операторів не пропускають велику кількість повідомлень одному абоненту за короткий проміжок часу.

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


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



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