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

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

• voice = m – чоловічий голос.
• voice = m2 – чоловічий альтернативний голос.
• voice = w – жіночий голос.
• voice = w2 – жіночий альтернативний голос.

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

• при 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"));
?>