API

Huggy.showButton() not available at SDK

Huggy.showButton();
1

Mostra o botão do Huggy Chat se ele estiver oculto.

✔️ Veja um exemplo de aplicação desse método.

Huggy.hideButton() not available at SDK

Huggy.hideButton();
1

Este método é responsável por ocultar o botão do Huggy Chat na página.

✔️ Veja um exemplo de aplicação desse método.

Huggy.showChats() not available at SDK

Huggy.showChats();
1

Mostra a lista de chats no Huggy Chat se eles estiverem ocultos.

Huggy.hideChats() not available at SDK

Huggy.hideChats();
1

Oculta a lista de histórico dos chats e redireciona para a última conversa do usuário. O chat redirecionado não é o mais recente, mas o que ocorreu na última interação.

Huggy.openBox() not available at SDK

Huggy.openBox();
1

Abre a janela do Huggy Chat, se estiver fechada.

✔️ Veja um exemplo de aplicação desse método.

Huggy.closeBox() not available at SDK

Huggy.closeBox();
1

Fecha a janela do Huggy Chat.

Huggy.openButtons() not available at SDK

Huggy.openButtons();
1

Cria e mostra a lista de canais registrados para atendimento.

✔️ Canais Telegram, Whatsapp, Email, Messenger.

Huggy.openChatByID(id) not available at SDK

Huggy.openChatByID(5);
1

Abre o chat de um determinado ID no Huggy Chat. Este chat deve estar na lista de chats do usuário atual.

Huggy.openEmail() not available at SDK

Huggy.openEmail();
1

Abre a janela de atendimento do canal email.

Huggy.openKnowledgeBase() not available at SDK

Huggy.openKnowledgeBase();
1

Abre a base de conhecimento registrada nas configurações do Huggy Chat (caso esteja definido).

Huggy.openMessenger() not available at SDK

Huggy.openMessenger();
1

Abre um atendimento utilizando o canal Messenger redirecionando para a página do Messenger.

Huggy.openPhone() not available at SDK

Huggy.openPhone();
1

Abre a tela para inserir os dados de telefone para agendar uma ligação.

Huggy.openTelegram() not available at SDK

Huggy.openTelegram();
1

Abre um atendimento utilizando o canal Telegram, redirecionando para a página Web do Telegram.

Huggy.openWhatsapp() not available at SDK

Huggy.openWhatsapp();
1

Abre um atendimento utilizando o canal Whatsapp, redirecionando para a página do Whatsapp Web.

Huggy.openInstagram() not available at SDK

Huggy.openInstagram();
1

Abre um atendimento utilizando o canal Instagram, redirecionando para a página do Instagram Web.

Huggy.recreateAttendance()

Huggy.recreateAttendance();
1

Cria um novo chat.

Huggy.removeChats(id) not available at SDK

Huggy.removeChats(2);
1

Remove um chat da lista a partir de seu ID.

Huggy.sendMessage(Hello)

Huggy.sendMessage('Hello Charles!');
1

Envia uma mensagem no chat.

Huggy.setCustomerPhoto(url)

⚠️ A url passada como parâmetro deve conter a extensão do arquivo de imagem.

Huggy.setCustomerPhoto('https://c.pzw.io/img/avatar-user-boy.jpg');
1

Altera a foto do perfil do cliente no Huggy Chat.

Huggy.setData()

Huggy.setData(nome, email, DDI, telefone);
1
Huggy.setData('Joao', 'joao@email.com', '+55', 11988888888);
1

A função Huggy.setData({}) atualiza automaticamente os dados de um contato no Huggy Chat e no Painel Huggy. É importante enfatizar que para definição dos campos personalizados, você deverá utilizar o Token (gerado automaticamente quando um campo personalizado é registrado) como a chave do objeto "custom_fields" seguido pelo valor desejado. Se você passar um Token inexistente ou inválido, o mesmo será ignorado.

Huggy.setData({
  customer: {
    name: 'João de Maria',

    mobile: '5511988888888',

    email: 'joao@email.com',

    custom_fields: {
      cpf_of_the_contact_customer: '000.000.000-00',

      cnpj_of_the_company_customer: '00.000.000/0000-00',

      date_of_birth_customer: '01/01/0050',

      corporate_e_mail_customer: 'a@aluan.com',

      activation_time_of_the_contact_customer: '12:00',

      comercial_phone_customer: '5511988888888'
    }
  },
  variables: [
    {
      key: 'huggy.perfil',
      value: 'Perfil de XXXXX'
    }
  ]
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

Nota: No seu sistema, quando o evento createChat é acionado para o sistema Huggy, as variáveis ​​devem ser passadas como o contexto inicial do chat. O método setData só funcionará com o chat criado.

Huggy.setEmail(email)

Huggy.setEmail('charles@test.com');
1

Altera o e-mail do cliente no Huggy Chat.

Huggy.setName(nome)

Huggy.setName('Charles');
1

Altera o nome do cliente no Huggy Chat.

Huggy.setPhone(DDI, telefone)

Huggy.setPhone("+55", "75999999999");
1

Altera o telefone do cliente no Huggy Chat.

Huggy.showTrigger(id) not available at SDK

Huggy.showTrigger(3)
1

Mostra determinado gatilho, usando seu ID.

✔️ Veja um exemplo de aplicação desse método.

Huggy.startTrigger(id, position, message) not available at SDK

Huggy.startTrigger(3, 0, 'Inicializa o gatilho');
1

Nota: A string que está sendo passada como parâmetro possui configurações no painel. Se passado no método, ela substitui o valor configurado. Somente o primeiro parâmetro é obrigatório, os demais são opcionais.

Executa a ação do botão do gatilho, somente neste método o ID é requerido. O ID é o ID do gatilho, a posição é a posição do botão dentro do gatilho e neste caso, como existe apenas um botão, esta é a posição padrão. Essa posição não pode ser alterada e o nome entre aspas é o nome que será exibido dentro do botão.

✔️ Veja um exemplo de aplicação desse método.

Huggy.startTrigger(2, 0, 'Abre o vídeo');
1

Huggy.subscribe(topico, call)

O usuário se inscreve para escutar os eventos dos tópicos {HuggyChatTopicsSubscribe} e executa uma função passada por parâmetro, como mostra o exemplo:

Huggy.subscribe('channel-open:whatsapp', function() {
  alert('whatsapp channel opened');
});
1
2
3

✔️ Veja um exemplo de aplicação desse método.

Existe um tópico específico (chat:created) que emite um objeto com o as seguintes propriedades.

{
  authHash: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUxxxxxxxxxx",
  chatID: 99999999,
  customerSiteID: 999999999,
  department: null,
  hash: "f82768b90a3bdc6868b5xxxxxxxx",
  last_notification: null,
  message: {customer: {}, agent: false, lastAgent: {}, chatOpened: false, subject: null,},
  presence: "GmcjuRCzyimW%2B3qBjzWyXwDJwaV6xxxxxxxxxxx",
  server: "https://ct.huggy.io",
  smartTriggerID: null,
  text: "Oi",
  token: "5fec1013617ad07c104f84xxxxxxxxxxx",
  whatsapp: null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Para obter esses dados você pode executar uma função como segue o exemplo:

Huggy.subscribe('chat:created', function(data) {
  console.log('This is the chat Id: ', data.chatID);
});
1
2
3

Huggy.destroy()

Esse método remove a instância do Huggy Chat da página. Para ativar novamente é necessário executar o Huggy.init. Após o destroy, o único método disponível é o Huggy.init.

Huggy.destroy();
1

Tipos