Добавление нотификаций

Для публикации уведомлений реализован публичный API, обращение к которому осуществляется посредством вызова соответствующих методов глобального объекта AMOCRM. При вызове метода необходимо передать объект с описанием уведомления.

Информационное уведомление

Метод предназначен для вызова всплывающего уведомления, которое отобразится у пользователя только в интерфейсе и не будет тиражировано по другим каналам доставки.

Название метода

show_message()

Параметры

Параметр Обязательный Описание
header Да Заголовок сообщения
text Да Текст уведомления
date Нет Дата в формате timstamp
icon Нет URL к файлу произвольной иконки. Если не передан, то используется иконка по умолчанию robot

Пример

  1. var message_params = {
  2.   header: "Внимание",
  3.   text: "Соединение установлено",
  4.   date: 1534084500,
  5.   icon: "https://www.example.com/images/telephone.png"
  6. };
  7. AMOCRM.notifications.show_message(message_params);

Результат

Уведомление об ошибке

Метод отображает в интерфейсе аккаунта информационное уведомление об ошибке, при этом сообщение не будет передано по другим каналам доставки.

Название метода

show_message_error()

Параметры

Параметр Обязательный Описание
header Да Заголовок сообщения
text Да Текст уведомления
date Нет Дата в формате timstamp
link Нет URL для переадресации при нажатии на уведомлении

Пример

  1. var error_params = {
  2.   header: "Внимание",
  3.   text: "Соединение с сервером потеряно"
  4. };
  5. AMOCRM.notifications.show_message_error(error_params);

Результат

Уведомление о входящем звонке

Метод позволяет отобразить всплывающее уведомление о звонке или об ошибке. При использовании данного сообщение отобразится только в интерфейсе и не будет передано по другим каналам.

Название метода

show_notification()

Параметры

Параметр Обязательный Описание
text Да Массив с описанием сообщения
text/header Да Заголовок уведомления
text/text Да Текстовое сообщение
date Нет Дата в формате timestamp
type Да Тип всплывающего уведомления. Может принимать значения call или type

Пример

  1. var notification = {
  2.   text: {
  3.     header: "Исходящий звонок",
  4.     text: "Набор номера +79876543210"
  5.   },
  6.   type: "call"
  7. };
  8. AMOCRM.notifications.show_notification(notification);

Результат

Пример

  1. var notification = {
  2.   text: {
  3.     header: "Ошибка",
  4.     text: "Произошла ошибка в работе виджета"
  5.   },
  6.   type: "error"
  7. };
  8. AMOCRM.notifications.show_notification(notification);

Результат

Добавление уведомления об ошибке

Метод позволяет добавить уведомление об ошибке в центр нотификаций. Сообщение будет отправлено по всем активным каналам в аккаунте пользователя.

Название метода

add_error()

Параметры

Параметр Обязательный Описание
header Нет Заголовок сообщения
text Да Текст уведомления
date Нет Дата в формате timstamp
link Нет Ссылка, по которой произойдёт переход при нажатии на уведомление

Пример

  1. var error_params = {
  2.     header: "Ошибка",
  3.     text: "Не удалось установить задачу! Контакт не найден!",
  4.     date: 1534085310,
  5.     link: "/contacts/list/?term=4951234567"
  6. };
  7. AMOCRM.notifications.add_error(error_params);

Результат

Письмо по событию, пришедшее на email.

Уведомление, пришедшее в мобильное приложение.

Уведомление о входящем вызове

API центра уведомлений позволяет выводить сообщение о входящем вызове. Уведомление будет передано по всем активным каналам доставки.

Название метода

add_call()

Параметры

Параметр Обязательный Описание
text Да Текстовое сообщение, которое будет отображено в уведомлении.
date Нет Дата в формате timestamp
from Нет Строка, в которой указывается инициатор входящего вызова. Номер телефона — если контакт не найден в аккаунте. Имя контакта — если звонок поступил от уже существующего в аккаунте контакта.
to Нет Имя менеджера или номер внутреннего телефона абонента, которому поступил входящий звонок.
element Нет Объект с описанием сущности, на которую произойдёт переход при нажатии на всплывающее уведомление о звонке.
element.id Да ID сущности
element.type Да Тип сущности: contact, lead или company

Параметр

  1. var call_params = {
  2.   text: "Звонок от +7(999)888 55 33",
  3.   date: 1534084500,
  4.   from: "Петрова Анна",
  5.   to: "Смирнов Алексей",
  6.   element: { id: 18221265, type: "contact" },
  7.   duration: 250,
  8.   link: 'https://example.com/dialog.mp3'
  9. };
  10. AMOCRM.notifications.add_call(call_params);

Результат

Уведомление о звонке в центре нотификаций и в мобильном приложении.