Para publicar notificações, é implementada uma API pública, acessada chamando os métodos correspondentes do objeto global APP da Kommo. Ao chamar o método, é necessário transferir um objeto com a descrição da notificação.

Aviso Informativo

O método é projetado para acionar uma notificação pop-up, que aparecerá apenas na interface e não será duplicada em outros canais de entrega.

Nome do método

show_message()

Parâmetro	Obrigatório?	Descrição
header	✅	Título do aviso
text	✅	Texto da notificação
date	❌	Data no formato Unix Timestamp
icon	❌	URL para um arquivo de ícone. Se não for informado, será usado o ícone padrão de robô.

Exemplo:

var message_params = {
  header: "Aviso",
  text: "Conexão estabelecida",
  date: 1714566795,
  icon: "https://www.example.com/images/telephone.png"
};
APP.notifications.show_message(message_params);

Resultado:

Notificação de erro

O método exibirá uma notificação de erro na interface da conta, e a mensagem não será enviada por outros canais de entrega.

Nome do método

show_message_error()

Parâmetros

Parâmetro	Obrigatório?	Descrição
header	✅	Título do aviso
text	✅	Texto da notificação
date	❌	Data no formato Unix Timestamp
link	❌	A URL para a qual o usuário será redirecionado ao clicar na notificação.

Example

var error_params = {
header: “Aviso”,
text: “Conexão com o servidor perdida”
};
APP.notifications.show_message_error(error_params);

Resultado

Notificação de chamada recebida

O método permite exibir uma notificação pop-up para uma chamada ou erro. Se esta funcionalidade for utilizada, ela aparecerá apenas na interface e não será enviada por outros canais.

Nome do método

show_notification()

Parâmetros

Parâmetro	Obrigatório?	Descrição
text	✅	Array com a descrição da mensagem.
text/header	✅	Cabeçalho da notificação
text/text	✅	Mensagem de texto
date	❌	Data no formato Unix Timestamp
type	✅	Tipo de notificação pop-up(`call` ou `error`)

Exemplo

var notification = {
  text: {
    header: "Chamada de saída",
    text: "Discando o número +19872345678"
  },
  type: "call"
};
APP.notifications.show_notification(notification);

Resultado

Exemplo

var notification = {
  text: {
    header: "Erro",
    text: "Erro ao trabalhar com o widget"
  },
  type: "error"
};
APP.notifications.show_notification(notification);

Resultado

Adicionando uma notificação de erro

O método permite adicionar uma notificação de erro ao centro de notificações, e a mensagem será enviada para todos os canais ativos na conta do usuário.

Nome do método

add_error()

Parâmetros

Parâmetro	Obrigatório?	Descrição
header	❌	Título do aviso
text	✅	Texto da notificação
date	❌	Data no formato Unix Timestamp
link	❌	A URL para onde o usuário será redirecionado ao clicar na notificação.

Exemplo

var error_params = {
    header: "Erro",
    text: "Falha ao configurar a tarefa! Contato não encontrado!",
    date: 1714566795,
    link: "/contacts/list/?term=4951234567"
};
APP.notifications.add_error(error_params);

Resultado

Notificação por e-mail sobre o erro:

Notificação recebida no aplicativo móvel:

Notificação de chamada recebida

A API do Centro de Notificações permite exibir uma mensagem de chamada recebida. A notificação será transmitida por todos os canais de entrega ativos.

Nome do método

add_call()

Parâmetros

Parâmetro	Obrigatório?	Descrição
text	✅	Mensagem de texto que será exibida na notificação.
date	❌	Data no formato Unix Timestamp
from	❌	A linha especifica o iniciador da chamada recebida. Mostra o número de telefone se não for encontrado na lista de contatos e o nome do contato se a chamada veio de um número na sua lista de contatos.
to	❌	Nome do gerente ou número de ramal do assinante que recebeu a chamada.
element	❌	Um objeto descrevendo a entidade de destino para a transição ao clicar na notificação de chamada pop-up.
element.id	✅	ID da entidade
element.type	✅	Tipo de entidade: contato, lead ou empresa
link	❌	Um link para a gravação da chamada

Parâmetro

var call_params = {
  text: "Chamada de +1 (415) 523-7743",
  date: 1714566795,
  from: "João Santos",
  to: "Maria da Silva",
  element: { id: 18221265, type: "contact" },
  duration: 250,
  link: 'https://example.com/dialog.mp3'
};
APP.notifications.add_call(call_params);