$_Huggy

$_Huggy é o objeto { HuggyChatConfig } de configuração principal do Huggy Chat. Esse código é encontrado na configuração do canal do Huggy Chat pelo painel. Basta copiar o código referente ao seu canal e inserir na sua página, de preferência antes do fechamento da tag body (</body>) ou antes do fechamento da tag head (</head>).

⚠️ Caso você tenha configurado um Huggy Chat antes de 15/10/2020, encontrará no código dele a propriedade widget_id, substituída hoje pela propriedade uuid. Para utilizar essa nova propriedade e continuar aproveitando as novidades da nossa API, recomendamos que você considere reconfigurar o seu Huggy Chat.

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
email	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

widget_id string

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:

company string

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:

defaultCountry string

Note:

DDI do país

Default: +55

name string

Note:

Define previamente o nome do contato que vai inicializar o chat

Default:

phone string

Note:

Define previamente o telefone do contato que vai inicializar o chat

Default:

email string

Note:

Define previamente o email do contato que vai inicializar o chat

Default:

channelGreeting string

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

afterLoad function

Note:

Evento callback que é executado ao término do carregamento do Huggy Chat

Default:

beforeLoad function

Note:

Evento callback que é executado antes do carregamento do Huggy Chat

Default:

mainColor string

Note:

Define a cor principal do Huggy Chat

Default:

colors object[HuggyChatConfigColors]

Note:

Objeto contendo as definições de cores para o Huggy Chat

Default:

$_Huggy.name

Define previamente o nome do contato que vai inicializar o chat

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    name: 'João da Silva'
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11

$_Huggy.phone

Define previamente o telefone do contato que vai inicializar o chat

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    phone: '1112345678'
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11

$_Huggy.email

Define previamente o email do contato que vai inicializar o chat

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    email: 'joao@dasilva.com'
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11

$_Huggy.channelGreeting

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.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    channelGreeting: 'Gostaria de tirar dúvidas'
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11

$_Huggy.afterLoad

Evento callback que é executado ao término do carregamento do Huggy Chat. Recebe-se uma função.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    afterLoad: function () {
      console.log('Código executado após o carregamento do widget')
    }
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13

✔️ Veja aqui um exemplo de aplicação desse recurso.

$_Huggy.beforeLoad

Evento callback que é executado antes do carregamento do Huggy Chat. Recebe-se uma função.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    beforeLoad: function () {
      console.log('Código executado antes do carregamento do widget')
    }
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13

$_Huggy.defaultCountry

É o DDI do país. O default é "+55".

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55'
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11

$_Huggy.mainColor

A propriedade mainColor define a cor principal do Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55',
    mainColor: "#d81adb"
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12

$_Huggy.colors

Objeto do tipo { HuggyChatConfigColors } contendo as definições de cores para o Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55',
    mainColor: "#d81adb",
    colors: {}
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13

colors.textTitle

A propriedade textTitle do objeto colors define a cor do título do Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55',
    mainColor: "#d81adb",
    colors: {
      "textTitle": "#b4bec0",
    }
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

colors.textReceivedMessage

A propriedade textReceivedMessage do objeto colors define a cor das mensagens recebidas pelo Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55',
    mainColor: "#d81adb",
    colors: {
      "textTitle": "#b4bec0",
      "textReceivedMessage": "#000000",
    }
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

colors.textSendMessage

A propriedade textSendMessage do objeto colors define a cor das mensagens enviadas pelo Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001",
    defaultCountry: '+55',
    mainColor: "#d81adb",
    colors: {
      "textTitle": "#b4bec0",
      "textReceivedMessage": "#6b7c80",
      "textSendMessage": "#000000"
    }
  };

  // ...
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

huggyData

Objeto do tipo { HuggyChatData } à parte da configuração ($_Huggy) que contém estrutura de dados. É declarado antes da inicialização do Huggy Chat e deve-se estar disponível dentro de window podendo ser acessado em window.huggyData

⚠️ Este objeto deve ser declarado antes da inicialização do Huggy Chat.

<!-- Init code Huggy Chat  //-->
<script>
  var huggyData = {};

  var $_Huggy = {
    defaultCountry: '+55',
    widget_id: '0001',
    company: "0001"
  };
  
  (function(i,s,o,g,r,a,m){ i[r]={context:{id:'8551dbde3f168db249381597eea81c71'}};a=o;o=s.createElement(o); o.async=1;o.src=g;m=s.getElementsByTagName(a)[0];m.parentNode.insertBefore(o,m); })(window,document,'script','https://js.huggy.chat/widget.min.js?v=8.0.0','pwz');
</script>
<!-- End code Huggy Chat  //-->

1
2
3
4
5
6
7
8
9
10
11
12
13

huggyData.variables

A propriedade variables é um array que deve receber objetos do tipo { HuggyChatDataVariable } com a chave key e o valor value. Esse recurso é utilizado para interagir com variáveis dentro do flow.

<script>
  var huggyData = {
    variables: [
      {
        key: 'clientid',
        value: 104
      }
    ]
  };
</script>

1
2
3
4
5
6
7
8
9
10

huggyData.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.

<script>
  var huggyData = {
    userIdentifier: 'user@company.com',
    userHash: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJ1c2VyMUBjb21wYW55LmNvbSJ9.upuQ_qWcSFWdzIAGjEfSi-v_RvWC-bicTLNyEePPOhY'
  }
</script>

1
2
3
4
5
6

huggyData.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.

<script>
  var huggyData = {
    userIdentifier: 'user@company.com',
    userHash: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJ1c2VyMUBjb21wYW55LmNvbSJ9.upuQ_qWcSFWdzIAGjEfSi-v_RvWC-bicTLNyEePPOhY'
  }
</script>

1
2
3
4
5
6

Saiba mais sobre autenticação

Tipos

← Apresentação API →

# $_Huggy

# $_Huggy.name

# $_Huggy.phone

# $_Huggy.email

# $_Huggy.channelGreeting

# $_Huggy.afterLoad

# $_Huggy.beforeLoad

# $_Huggy.defaultCountry

# $_Huggy.mainColor

# $_Huggy.colors

# colors.textTitle

# colors.textReceivedMessage

# colors.textSendMessage

# huggyData

# huggyData.variables

# huggyData.userIdentifier

# huggyData.userHash

# Tipos

$_Huggy

$_Huggy.name

$_Huggy.phone

$_Huggy.email

$_Huggy.channelGreeting

$_Huggy.afterLoad

$_Huggy.beforeLoad

$_Huggy.defaultCountry

$_Huggy.mainColor

$_Huggy.colors

colors.textTitle

colors.textReceivedMessage

colors.textSendMessage

huggyData

huggyData.variables

huggyData.userIdentifier

huggyData.userHash

Tipos