API
not available at SDK
Huggy.showButton()Huggy.showButton();
Mostra o botão do Huggy Chat se ele estiver oculto.
✔️ Veja um exemplo de aplicação desse método.
not available at SDK
Huggy.hideButton()Huggy.hideButton();
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.
not available at SDK
Huggy.showChats()Huggy.showChats();
Mostra a lista de chats no Huggy Chat se eles estiverem ocultos.
not available at SDK
Huggy.hideChats()Huggy.hideChats();
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.
not available at SDK
Huggy.openBox()Huggy.openBox();
Abre a janela do Huggy Chat, se estiver fechada.
✔️ Veja um exemplo de aplicação desse método.
not available at SDK
Huggy.closeBox()Huggy.closeBox();
Fecha a janela do Huggy Chat.
not available at SDK
Huggy.openButtons()Huggy.openButtons();
Cria e mostra a lista de canais registrados para atendimento.
✔️ Canais Telegram, Whatsapp, Email, Messenger.
not available at SDK
Huggy.openChatByID(id)Huggy.openChatByID(5);
Abre o chat de um determinado ID
no Huggy Chat. Este chat deve estar na lista de chats do usuário atual.
not available at SDK
Huggy.openEmail()Huggy.openEmail();
Abre a janela de atendimento do canal email.
not available at SDK
Huggy.openKnowledgeBase()Huggy.openKnowledgeBase();
Abre a base de conhecimento registrada nas configurações do Huggy Chat (caso esteja definido).
not available at SDK
Huggy.openMessenger()Huggy.openMessenger();
Abre um atendimento utilizando o canal Messenger redirecionando para a página do Messenger.
not available at SDK
Huggy.openPhone()Huggy.openPhone();
Abre a tela para inserir os dados de telefone para agendar uma ligação.
not available at SDK
Huggy.openTelegram()Huggy.openTelegram();
Abre um atendimento utilizando o canal Telegram, redirecionando para a página Web do Telegram.
not available at SDK
Huggy.openWhatsapp()Huggy.openWhatsapp();
Abre um atendimento utilizando o canal Whatsapp, redirecionando para a página do Whatsapp Web.
not available at SDK
Huggy.openInstagram()Huggy.openInstagram();
Abre um atendimento utilizando o canal Instagram, redirecionando para a página do Instagram Web.
Huggy.recreateAttendance()
Huggy.recreateAttendance();
Cria um novo chat.
not available at SDK
Huggy.removeChats(id)Huggy.removeChats(2);
Remove um chat da lista a partir de seu ID
.
Huggy.sendMessage(Hello)
Huggy.sendMessage('Hello Charles!');
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');
Altera a foto do perfil do cliente no Huggy Chat.
Huggy.setData()
Huggy.setData(nome, email, DDI, telefone);
Huggy.setData('Joao', 'joao@email.com', '+55', 11988888888);
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'
}
]
});
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');
Altera o e-mail do cliente no Huggy Chat.
Huggy.setName(nome)
Huggy.setName('Charles');
Altera o nome do cliente no Huggy Chat.
Huggy.setPhone(DDI, telefone)
Huggy.setPhone("+55", "75999999999");
Altera o telefone do cliente no Huggy Chat.
not available at SDK
Huggy.showTrigger(id)Huggy.showTrigger(3)
Mostra determinado gatilho, usando seu ID.
✔️ Veja um exemplo de aplicação desse método.
not available at SDK
Huggy.startTrigger(id, position, message)Huggy.startTrigger(3, 0, 'Inicializa o gatilho');
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');
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');
});
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
}
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);
});
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();
Tipos
HuggyChatConfig
Property | Type | Note | Description | Default | |
---|---|---|---|---|---|
widget_id | string | Deprecated | ID único do seu Huggy Chat. Obrigatório para o funcionamento do chat, presente no código de instação que encontra-se na configuração do canal | ||
company | string | ID único da sua conta da Huggy. Obrigatório para o funcionamento do chat, presente no código de instação que encontra-se na configuração do canal | |||
defaultCountry | string | DDI do país | +55 | opcional | |
name | string | Define previamente o nome do contato que vai inicializar o chat | opcional | ||
phone | string | Define previamente o telefone do contato que vai inicializar o chat | opcional | ||
string | Define previamente o email do contato que vai inicializar o chat | opcional | |||
channelGreeting | string | Essa propriedade é utilizada nos links de "Me Chame no Whatsapp" e "Me Chame no Telegram". O default é "Oi" e, com essa propriedade, pode ser alterada para ambos os serviços | Oi | opcional | |
afterLoad | function | Evento callback que é executado ao término do carregamento do Huggy Chat | opcional | ||
beforeLoad | function | Evento callback que é executado antes do carregamento do Huggy Chat | opcional | ||
mainColor | string | Define a cor principal do Huggy Chat | opcional | ||
colors | object[HuggyChatConfigColors] | Objeto contendo as definições de cores para o Huggy Chat | opcional |
Note: Deprecated
ID único do seu Huggy Chat. Obrigatório para o funcionamento do chat, presente no código de instação que encontra-se na configuração do canal
Default:
Note:
ID único da sua conta da Huggy. Obrigatório para o funcionamento do chat, presente no código de instação que encontra-se na configuração do canal
Default:
Note:
DDI do país
Default: +55
Note:
Define previamente o nome do contato que vai inicializar o chat
Default:
Note:
Define previamente o telefone do contato que vai inicializar o chat
Default:
Note:
Define previamente o email do contato que vai inicializar o chat
Default:
Note:
Essa propriedade é utilizada nos links de "Me Chame no Whatsapp" e "Me Chame no Telegram". O default é "Oi" e, com essa propriedade, pode ser alterada para ambos os serviços
Default: Oi
Note:
Evento callback que é executado ao término do carregamento do Huggy Chat
Default:
Note:
Evento callback que é executado antes do carregamento do Huggy Chat
Default:
Note:
Define a cor principal do Huggy Chat
Default:
Note:
Objeto contendo as definições de cores para o Huggy Chat
Default:
HuggyChatInit
Property | Type | Description | Default | |
---|---|---|---|---|
contextID | string | ID de contexto. Você pode encontrá-lo no script de inicialização presente no código de instalação do seu Huggy Chat, fornecido pela nossa plataforma durante a configuração do canal. | ||
... | HuggyChatConfig | Todas as propriedades presentes em HuggyChatConfig são herdadas por HuggyChatInit. |
ID de contexto. Você pode encontrá-lo no script de inicialização presente no código de instalação do seu Huggy Chat, fornecido pela nossa plataforma durante a configuração do canal.
Default:
Todas as propriedades presentes em HuggyChatConfig são herdadas por HuggyChatInit.
Default:
HuggyChatLogin
Property | Type | Description | ||
---|---|---|---|---|
userIdentifier | string | Define o identificador único do usuário. Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userHash. | ||
userHash | string | Define o token de autenticação do usuário (no padrão JWT). Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userIdentifier. |
Define o identificador único do usuário. Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userHash.
Define o token de autenticação do usuário (no padrão JWT). Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userIdentifier.
HuggyChatLogout
Parameter | Type | Description | Default | |
---|---|---|---|---|
reload | boolean | Permite recarregar o Huggy Chat após encerrar a sessão do usuário autenticado. | true | opcional |
fnBeforeInit | function | Método callback disparado logo após encerrar a sessão do usuário autenticado. | function | opcional |
Permite recarregar o Huggy Chat após encerrar a sessão do usuário autenticado.
Default: true
Método callback disparado logo após encerrar a sessão do usuário autenticado.
Default: function
HuggyChatData
Property | Type | Description | Default | |
---|---|---|---|---|
variables | array[HuggyChatDataVariable] | Array de variáveis | ||
userIdentifier | string | Define o identificador único do usuário. Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userHash. | ||
userHash | string | Define o token de autenticação do usuário (no padrão JWT). Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userIdentifier. |
Define o identificador único do usuário. Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userHash.
Default:
Define o token de autenticação do usuário (no padrão JWT). Essa propriedade é utilizada no processo de autenticação do Huggy Chat e deve estar sempre acompanhada da propriedade userIdentifier.
Default:
HuggyChatDataVariable
Property | Type | Description |
---|---|---|
key | string | Chave da variável. No flow é a chamada dela. Ex: {{ chave }} |
value | string|integer | Valor da variável |
Chave da variável. No flow é a chamada dela. Ex: {{ chave }}
Valor da variável
HuggyChatTopicsSubscribe
Topics | Return | Description |
---|---|---|
channel-open:whatsapp | Evento disparado quando o canal do WhatsApp é aberto | |
channel-close:widget | Evento disparado quando o canal do Huggy Chat é fechado | |
box-opened:chat | Evento disparado quando o canal do Huggy Chat é aberto | |
box-opened:email | Evento disparado quando o formulário do email é aberto | |
box-opened:phone | Evento disparado quando o formulário do telefone é aberto | |
box-opened | Evento disparado quando a caixa do chat é aberta | |
box-closed | Evento disparado quando a caixa do chat é fechada | |
chat:message | Evento disparado quando uma mensagem é enviada no chat | |
chat:created | object | Evento disparado quando um chat é criado, ou seja, na primeira mensagem enviada |
Evento disparado quando o canal do WhatsApp é aberto
Evento disparado quando o canal do Huggy Chat é fechado
Evento disparado quando o canal do Huggy Chat é aberto
Evento disparado quando o formulário do email é aberto
Evento disparado quando o formulário do telefone é aberto
Evento disparado quando a caixa do chat é aberta
Evento disparado quando a caixa do chat é fechada
Evento disparado quando uma mensagem é enviada no chat
HuggyChatConfigColors
Property | Type | Description |
---|---|---|
textTitle | string | Define a cor do título do Huggy Chat |
textReceivedMessage | string | Define a cor do texto das mensagens recebidas pelo Huggy Chat |
textSendMessage | string | Define a cor do texto das mensagens enviadas pelo Huggy Chat |
Define a cor do título do Huggy Chat
Define a cor do texto das mensagens recebidas pelo Huggy Chat
Define a cor do texto das mensagens enviadas pelo Huggy Chat
← $_Huggy Autenticação →