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

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

РІЗНЕ

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

Для відправки голосового повідомлення необхідно викликати методом GET або POST адреса: https://smsc.ua/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&call=1
При формуванні повідомлення можна вказувати як текст, так і додавати медіа-файли форматів wav і mp3.

Якщо планується передача файлів, то їх необхідно передавати методом POST в тілі http(s)-запиту до сервера. Позиції в тексті, в які планується вставляти файли, необхідно позначати спеціальним чином у вигляді "<file n>", де n - номер файлу в формованому списку починаючи з одиниці. Якщо не вказувати позиції, то відповідні файли будуть додаватися в кінець повідомлення.

При створенні повідомлення можна вставляти в текст http(s)-посилання раніше завантажених файлів, дізнатися які можна в особистому кабінеті на сторінці відправки, натиснувши послідовно посилання "прикріпити файл" - "Завантажені файли". Також можна вказувати локальні посилання на завантажені файли на нашому сервері у вигляді "<file /upload/files/sms/каталог_загрузки/название_файла>". Щоб завантажити файл із зовнішнього джерела можна в запиті передавати додатковий параметр fileurl, що містить повну http(s)-адресу файлу. У цьому випадку передача в запиті параметра mes необов'язкова.

Так як телефонні лінії не можуть ідеально програвати складні медіа-файли, то при формуванні відправляється повідомлення передаються файли перетворюються до простого формату.

При відправці голосового повідомлення початковий час і вартість розраховуються приблизно. Після відправки і прослуховування повідомлення абонентом тривалість і вартість дзвінка коригуються або в меншу сторону (наприклад, якщо абонент дослухав повідомлення до кінця), або, якщо тривалість повідомлення перевищує розраховану, то різниця в секундах вказується в коментарі до повідомлення у вигляді додаткового часу overtime, яке в тому числі відображається в деталізації у вигляді окремого запису. Також overtime може виникати при використанні голосового меню (IVR).

Максимальна кількість вкладень, переданих у запиті, дорівнює чотирьом, і розмір кожного вкладення не повинен перевищувати 3 Мб. При перевищенні зазначених лімітів оброблювані вкладення будуть виключатися.

Для передачі свого номера телефону в якості імені відправника необхідно вказати його у параметрі sender. Зазначений номер перш повинен бути доданий та активований в особистому кабінеті на цієї сторінці.

При формуванні запиту можна передавати спеціальний параметр param, в якому задаються деякі характеристики дзвінка (більш детально можна ознайомитися в описі). Також додатково в запиті можна передати параметр voice, який визначає голос, використовуваний для озвучування тексту. Даний параметр може приймати такі значення:
  • voice = m – чоловічий голос.
  • voice = m2 – чоловічий альтернативний голос.
  • voice = w – жіночий голос.
  • voice = w2 – жіночий альтернативний голос.

Відправка коду в телефонному номері

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

Щоб передати код у телефонному номері необхідно надіслати абоненту спеціальне голосове повідомлення (дзвінок) зі словом code. При отриманні дзвінка абонент може його скинути або підняти трубку. При піднятті трубки система сама скине дзвінок. Останні 6 цифр номеру, з якого прийшов дзвінок, будуть секретним кодом, його необхідно використовувати абоненту для підтвердження операції. Також можливо використання більш короткого коду номера, вказавши кількість цифр в інструкції для користувачів на своєму сайті.

Для відправки зазначеного коду через API необхідно виконати запит на відправку голосового повідомлення, отримати згенерований код з відповіді системи і зберегти його на своєму боці. Саме цей код прийде абонента в телефонному номері при дзвінку і потрібно для підтвердження операції.

Формат запиту та відповідь Сервера: https://smsc.ua/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=code&call=1
У разі успішної обробки запиту повертається рядок наступного виду (у стандартну відповідь Сервера додається параметр code):
  • при fmt = 0: OK - <n> SMS, ID - <id>, CODE - <code>

  • при fmt = 1: <id>,<n>,<code>

  • при fmt = 2 (xml):
    <result>
    <id>id</id>
    <cnt>n</cnt>
    <code>code</code>
    </result>

  • при fmt = 3 (json):
    {
    "id": <id>,
    "cnt": <n>,
    "code": "<code>"
    }

    При використанні даної функції не можна передавати параметр voice, так як при його явної передачі в запиті відбудеться звичайне озвучування тексту повідомлення.

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

    Для використання голосового меню необхідно на початку тексту повідомлення передати текст або голосовий файл з початковими інструкціями для абонента і далі вказати макрос, що містить службові команди меню {menu: <...>}, де <...> опис параметрів голосового меню.

    Схематично повідомлення з використанням голосового меню, виглядає наступним чином:
    СТАРТОВЫЙ ТЕКСТ

    {menu: [ТЕКСТ МЕНЮ]
    1: ТЕКСТ или КОМАНДА
    2
    : ТЕКСТ2 или КОМАНДА2
    ...
    }

    КОНЕЧНЫЙ ТЕКСТ

    Після підняття трубки абоненту озвучується "СТАРТОВИЙ ТЕКСТ", далі програється "ТЕКСТ МЕНЮ" з описом пунктів меню і допустимими діями. Після натискання клавіші на цифровій клавіатурі телефону, що відповідає необхідному пункту, абоненту може бути озвучений текст "ТЕКСТ" або виконана одна або декілька наступних одина за одною "КОМАНД". Після виходу з меню озвучується "КІНЦЕВИЙ ТЕКСТ".

    Опис параметрів, використовуваних в макросі {menu: <...>}:

    ПараметрЗначення
    *: backДля повернення до попереднього меню.
    #: startПовернення в початок меню і повтор "ТЕКСТУ МЕНЮ".
    0: repeatПовтор вибраного пункту.
    n: msgПункт меню, в який потрапляє абонент при натисканні на клавішу n, де n - номер пункту меню, який може набувати значень від 1 до 9, msg - повідомлення або команда. Пункти меню можна дублювати один за одним для виконання декількох дій при натисканні на одну клавішу.
    nm: msgПідпункт m пункту n меню, в який потрапляє абонент при натисканні на клавішу m. Може приймати значення від 1 до 9. msg - повідомлення або команда. Підпункти меню можна дублювати один за одним для виконання декількох дій при натисканні на одну клавішу. Вкладеність підпунктів обмежена тільки розміром всього повідомлення (1000 символів).

    У пунктах і підпунктах можна використовувати наступні команди:

    КомандаЗначення
    urlАдреса http(s)-обробника Клієнта, на який буде передана інформація про поточний пункті і часу знаходження абонента в меню.
    call:phone wait=n ok:end err:nПеренаправлення дзвінка абонента на вказаний номер телефону, де обов'язковим параметром є phone - номер телефону або список номерів телефонів через кому. Можна вказати до 9 номерів. Номери, на які буде відбуватися перенаправлення дзвінка абонента необхідно зареєструвати на даній сторінці.
    Необов'язковими параметрами є:
    wait=n - час очікування підняття трубки абонентом, якому був перенаправлений дзвінок, де n - час очікування в секундах. Діапазон можливих значень параметра від 0 до 120. За замовчуванням час очікування підняття трубки абонентом 120 секунд.
    ok:end - після успішного з'єднання з зазначеним номером та закінчення діалогу завершити голосове меню.
    err:n - якщо додзвонитися до вказаного номера не вдалося, то перейти на крок чи мітку n, описану в тілі меню. Мітка може приймати значення будь-якого набору латинських букв і цифр.
    sms:phone,sender,msgВідправка SMS-повідомлення на вказаний номер телефону, де phone - номер телефону, sender - ім'я відправника, msg - текст повідомлення.
    endОзнака виходу з голосового меню. Після виходу буде прочитаний "КІНЦЕВИЙ ТЕКСТ".
    Приклади:

    <?php
    $url
    = 'https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999,79999999998&call=1&charset=utf-8&mes=';

    $msg = 'Здравствуйте!

    {menu: Нажмите 1 для первого пункта, 2 для второго пункта, 3 для отправки заявки на обратный звонок, 5 для связи с оператором, решетка для перехода в начало, 0 для повтора, для возврата в предыдущее меню нажмите звёздочку.
    *: back
    #: start
    0: repeat
    1: пункт 1, нажмите 1 для подпункта 1, 2 для подпункта 2, 3 для подпункта 3
    11: подпункт 1.1
    12: подпункт 1.2
    13: подпункт 1.3
    2: пункт 2, нажмите 1 для подпункта 2.1
    21: подпункт 2.1
    3: sms:79999999999,Sender,текст
    3: end
    5: url
    5: call:79999999999,79999999998 wait=10 ok:end err:6
    6: call:79999999997 wait=60 ok:end err:callerr
    err: неверный номер, нажмите 0 для повтора
    callerr: Извините, не удалось дозвониться до оператора, выберите другой пункт или повторите попытку позже}

    Всего вам доброго!'
    ;

    echo
    file_get_contents($url.urlencode($msg));
    ?>

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

    Приклади:

    Відправка голосового повідомлення з текстом "Hello":

    https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&call=1
    Відправка голосового повідомлення з текстом "Hello" від номера телефону "79991234567":

    https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&call=1&sender=79991234567
    Відправка голосового повідомлення з текстом "Hello world", озвученими чоловічим голосом, з часом очікування зняття трубки 20 секунд, інтервалом повтору 10 секунд і кількістю спроб дозвону рівним 3:

    https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello%20world&call=1&voice=m&param=20%2C10%2C3
    Відправка голосового повідомлення з текстом "Hello world", озвученими жіночим альтернативним голосом:

    https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello%20world&call=1&voice=w2
    Відправка голосового повідомлення з прикріпленим через параметр fileurl голосовим файлом:

    https://smsc.ua/sys/send.php?login=alex&psw=123&phones=79999999999&call=1&fileurl=http://mysite.com/voice.wav
    Відправка голосового повідомлення з текстом і двома звуковими файлами через бібліотеки на основі cURL:

    <?php
    include "smsc_api.php";
    send_sms("79999999999", "first file <file 1> and second file <file 2>", 0, 0, 0, 9, false, "", array("/home/alex/1.mp3", "/home/alex/2.wav"));
    ?>



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