Дзвінки, метод: /api/registercall/
Приклад:
№ | Поле | Тип | Опис | Обов'язкове чи ні | Коментар |
1 | login | string | Логін в системі BOX | Обов'язкове поле. | |
2 | password | string | Пароль в форматі md5 | Обов'язкове поле. | Напишіть в техпідтримку і ми видамо вам hash для API |
3 | channel | string | Канал дзвінка (ідентифікатор дзвінка) | Обов'язкове поле. | |
4 | status | string | Статус дзвінка | Обов'язкове поле. | Дзвінок може створити клуб зі статусами: LOCAL, INCOMING, OUTGOING, TRANSFER. Якщо ви передасте статуси завершального дзвінка (CANCEL, ANSWER, CONGESTION, CHANUNAVAIL, BUSY, INVALID, TRANSFER), то дзвінок закриється. Детально про кожен статус: LOCAL - Локальний дзвінок (внутрішній) INCOMING - Вхідний дзвінок OUTGOING - Вихідний дзвінок TRANSFER - Дзвінок переведений CANCEL - caller поклав трубку ANSWER - Є відповідь на дзвінок (є розмова) CONGESTION - лінія перевантажена CHANUNAVAIL - лінія недоступна BUSY - лінія зайнята NOANSWER - callee не відповів на дзвінок INVALID - некоректний номер / переклад |
5 | caller | integer | Хто дзвонить (номер телефону) | Обов'язкове поле. | |
6 | callee | integer | Кому дзвонить (номер телефону) | Не обов'язкове поле. | Якщо не вказувати тут нічого то система при вхідному дзвінку буде підставляти сюди номера за замовчуванням |
7 | pickup | integer | хто підняв трубку при груповому дзвінку | Не обов'язкове поле. | |
8 | duration | integer | тривалість виклику | Не обов'язкове поле. | Передавайте сюди тривалість дзвінка при зарешающіх статусах (CANCEL, ANSWER, CONGESTION, CHANUNAVAIL, BUSY, INVALID, TRANSFER) |
8 | filename | string | Шлях і ім'я аудіофайлу при дзвінках | Не обов'язкове поле. | Передавайте сюди ім'я аудіофайлу дзвінка при зарешающіх статусах (CANCEL, ANSWER, CONGESTION, CHANUNAVAIL, BUSY, INVALID, TRANSFER) |
9 | comment | text | Коментар до дзвінка | Не обов'язкове поле. | Коментар до дзвінка буде записаний як опис події |
10 | closed | bool | Закрити дзвінок і спливаюче вікно | Не обов'язкове поле. | Чи не обов'язкове поле.Якщо буде переданий аргумент closed = 1 то вікно закриється, якщо closed = 0 то немає (це все при статусах дзвінка ANSWER або CANCEL або CONGESTION або CHANUNAVAIL або BUSY або INVALID) . Так само рекомендується передавати closed = 0 в момент коли почалася розмова |
Можливі варіанти відповіді на запит
№ | Статус | Повідомлення | Опис повідомлення |
1 | ok | Реєстрація дзвінка пройшла успішно | |
2 | fail | Login is empty! | Відсутня логін |
3 | fail | Password is empty! | Відсутня пароль |
4 | fail | Login or password not correct! | Невірний логін або пароль |
5 | fail | Bad user level! | Низький рівень користувача, для виконання даної дії (потрібен level 2 і вище) |
6 | fail | No channel | Відсутня канал дзвінка |
7 | fail | No status | Відсутня статус дзвінка |
8 | fail | No caller | Відсутня номер того, хто телефонував |