Для публикации уведомлений реализован публичный API, обращение к которому осуществляется посредством вызова соответствующих методов глобального объекта APP. При вызове метода необходимо передать объект с описанием уведомления.
Метод предназначен для вызова всплывающего уведомления, которое отобразится у пользователя только в интерфейсе и не будет тиражировано по другим каналам доставки.
show_message()
Параметр | Обязательный | Описание |
---|---|---|
header | Да | Заголовок сообщения |
text | Да | Текст уведомления |
date | Нет | Дата в формате timstamp |
icon | Нет | URL к файлу произвольной иконки. Если не передан, то используется иконка по умолчанию robot |
var message_params = {
header: "Внимание",
text: "Соединение установлено",
date: 1534084500,
icon: "https://www.example.com/images/telephone.png"
};
APP.notifications.show_message(message_params);
Метод отображает в интерфейсе аккаунта информационное уведомление об ошибке, при этом сообщение не будет передано по другим каналам доставки.
show_message_error()
Параметр | Обязательный | Описание |
---|---|---|
header | Да | Заголовок сообщения |
text | Да | Текст уведомления |
date | Нет | Дата в формате timstamp |
link | Нет | URL для переадресации при нажатии на уведомлении |
var error_params = {
header: "Внимание",
text: "Соединение с сервером потеряно"
};
APP.notifications.show_message_error(error_params);
Метод позволяет отобразить всплывающее уведомление о звонке или об ошибке. При использовании данного сообщение отобразится только в интерфейсе и не будет передано по другим каналам.
show_notification()
Параметр | Обязательный | Описание |
---|---|---|
text | Да | Массив с описанием сообщения |
text/header | Да | Заголовок уведомления |
text/text | Да | Текстовое сообщение |
date | Нет | Дата в формате timestamp |
type | Да | Тип всплывающего уведомления. Может принимать значения call или error |
var notification = {
text: {
header: "Исходящий звонок",
text: "Набор номера +79876543210"
},
type: "call"
};
APP.notifications.show_notification(notification);
var notification = {
text: {
header: "Ошибка",
text: "Произошла ошибка в работе виджета"
},
type: "error"
};
APP.notifications.show_notification(notification);
Метод позволяет добавить уведомление об ошибке в центр нотификаций. Сообщение будет отправлено по всем активным каналам в аккаунте пользователя.
add_error()
Параметр | Обязательный | Описание |
---|---|---|
header | Нет | Заголовок сообщения |
text | Да | Текст уведомления |
date | Нет | Дата в формате timstamp |
link | Нет | Ссылка, по которой произойдёт переход при нажатии на уведомление |
var error_params = {
header: "Ошибка",
text: "Не удалось установить задачу! Контакт не найден!",
date: 1534085310,
link: "/contacts/list/?term=4951234567"
};
APP.notifications.add_error(error_params);
API центра уведомлений позволяет выводить сообщение о входящем вызове. Уведомление будет передано по всем активным каналам доставки.
add_call()
Параметр | Обязательный | Описание |
---|---|---|
text | Да | Текстовое сообщение, которое будет отображено в уведомлении. |
date | Нет | Дата в формате timestamp |
from | Нет | Строка, в которой указывается инициатор входящего вызова. Номер телефона — если контакт не найден в аккаунте. Имя контакта — если звонок поступил от уже существующего в аккаунте контакта. |
to | Нет | Имя менеджера или номер внутреннего телефона абонента, которому поступил входящий звонок. |
element | Нет | Объект с описанием сущности, на которую произойдёт переход при нажатии на всплывающее уведомление о звонке. |
element.id | Да | ID сущности |
element.type | Да | Тип сущности: contact, lead или company |
element.name | Нет | Название сущности |
link | Нет | Ссылка на запись звонка |
click_link | Нет | Ссылка, переход на которую будет произведен при нажатии на уведомление |
var call_params = {
text: "Звонок от +7(999)888 55 33",
date: 1534084500,
from: "Петрова Анна",
to: "Смирнов Алексей",
element: {
id: 18221265,
type: "contact"
},
duration: 250,
link: "https://example.com/dialog.mp3"
};
APP.notifications.add_call(call_params);
var call_params = {
text: "Звонок от +7(999)888 55 33",
date: 1534084500,
from: "Петрова Анна",
to: "Смирнов Алексей",
click_link: "/contacts/add/?phone=9191234567",
};
APP.notifications.add_call(call_params);