⚙️ Referência Completa de Parâmetros

O widget pode ser configurado através do objeto window.taubotConfig. Aqui está a documentação completa de todos os parâmetros disponíveis:

🔧 Parâmetros Obrigatórios

appId string obrigatório

Identificador único do seu bot fornecido pelo TAU.

appId: 'meusite.com.br'

🎨 Aparência do Botão

chatbotButtonBackground string

Cor de fundo do botão do chat. Aceita qualquer valor CSS válido.

chatbotButtonBackground: '#4834D4' // Padrão: '#009588'
chatbotButtonForeground string

Cor do ícone/texto do botão do chat.

chatbotButtonForeground: '#FFFFFF' // Padrão: '#FFFFFF'
chatbotButtonSize number

Tamanho do botão em pixels.

chatbotButtonSize: 60 // Padrão: 62
showChatbotButton boolean

Define se o botão do chat deve ser exibido.

showChatbotButton: true // Padrão: true

📍 Posicionamento

chatbotButtonBottom number

Distância em pixels da borda inferior da tela.

chatbotButtonBottom: 20 // Padrão: 20
chatbotButtonRight number

Distância em pixels da borda direita da tela.

chatbotButtonRight: 20 // Padrão: 20
chatbotSpaceFromButton number

Espaço em pixels entre o botão e a janela do chat.

chatbotSpaceFromButton: 72 // Padrão: 72

📱 Dimensões da Janela de Chat

chatWidth number

Largura da janela de chat em pixels (modo padrão).

chatWidth: 400 // Padrão: 400
chatWidthCool number

Largura da janela de chat em pixels (modo cool).

chatWidthCool: 700 // Padrão: 700
maxChatHeight number

Altura máxima da janela de chat em pixels.

maxChatHeight: 700 // Padrão: 700
percentChatHeight number

Porcentagem da altura da tela que o chat deve ocupar.

percentChatHeight: 80 // Padrão: 80
mobileWidthThreshold number

Largura em pixels que define quando usar layout mobile.

mobileWidthThreshold: 500 // Padrão: 500

🚀 Comportamento

autoOpen boolean

Define se o chat deve abrir automaticamente ao carregar a página.

autoOpen: true // Padrão: false
alwaysOpenOnMobile boolean

Força abertura automática em dispositivos móveis.

alwaysOpenOnMobile: true // Padrão: false
closeChatOnOutsideClick boolean

Fecha o chat ao clicar fora da janela.

closeChatOnOutsideClick: true // Padrão: false
mode string

Modo de exibição do chat. Opções: 'default' ou 'cool'.

mode: 'cool' // Padrão: 'default'
compare Diferenças entre Modos
🎯 Modo Default
  • Chat posicionado próximo ao botão
  • Largura: 400px (chatWidth)
  • Sem overlay de fundo
  • Mais discreto e tradicional
  • Ideal para sites corporativos
🎨 Modo Cool
  • Chat centralizado na tela
  • Largura: 700px (chatWidthCool)
  • Overlay escuro no fundo
  • Mais moderno e chamativo
  • Ideal para sites jovens/modernos
defaultRoute string

Rota inicial do chat. Opções: 'home' ou 'chat'.

defaultRoute: 'chat' // Padrão: 'home'
defaultMessage string

Mensagem pré-preenchida na caixa de entrada do chat.

defaultMessage: 'Olá! Preciso de ajuda.' // Padrão: null

💬 Integração WhatsApp

enableWhatsApp boolean

Ativa o modo WhatsApp, redirecionando para o WhatsApp.

enableWhatsApp: true // Padrão: false
whatsAppNumber string

Número do WhatsApp para redirecionamento (formato internacional).

whatsAppNumber: '+5511999999999' // Padrão: '+5511999392256'
whatsAppMessage string

Mensagem pré-preenchida ao abrir o WhatsApp.

whatsAppMessage: 'Olá! Vim do site e preciso de ajuda.' // Padrão: null

🎭 Personalização Visual Avançada

calloutBorder string

Cor da borda dos elementos callout.

calloutBorder: '#A8A8A8' // Padrão: '#A8A8A8'
calloutBackgroundColor string

Cor de fundo dos elementos callout.

calloutBackgroundColor: '#FFFFFF' // Padrão: '#FFFFFF'
calloutFontColor string

Cor do texto dos elementos callout.

calloutFontColor: '#333333' // Padrão: '#333333'
chatbotButtonOpenStateSVG string

Código SVG customizado para o ícone do botão quando o chat está aberto.

chatbotButtonOpenStateSVG: '<svg>...</svg>'
chatbotButtonClosedStateSVG string

Código SVG customizado para o ícone do botão quando o chat está fechado.

chatbotButtonClosedStateSVG: '<svg>...</svg>'
chat Exemplo: Ícone WhatsApp

Para usar o ícone oficial do WhatsApp:

chatbotButtonBackground: '#00E676',
chatbotButtonOpenStateSVG: '<svg viewBox="0 0 260 260" fill="none" xmlns="http://www.w3.org/2000/svg"><g><path d="M67.6631045,221.823373 L71.8484512,223.916047..."></path></g></svg>'

Ideal para uso com enableWhatsApp: true

🔧 Configurações Técnicas

baseAppUrl string

URL base da aplicação TAU (normalmente não deve ser alterada).

baseAppUrl: 'https://app.taubot.ai' // Padrão: ambiente local
baseAPIUrl string

URL base da API TAU (normalmente não deve ser alterada).

baseAPIUrl: 'https://api.taubot.ai' // Padrão: ambiente local
buttonId string

ID HTML do elemento botão (uso interno).

buttonId: 'chatbot-button' // Padrão: 'chatbot-button'
iframeId string

ID HTML do elemento iframe (uso interno).

iframeId: 'chatbot-iframe' // Padrão: 'chatbot-iframe'
deviceId string

Identificador único do dispositivo (gerado automaticamente).

deviceId: null // Padrão: null (auto-gerado)

☁️ Configuração Remota (API)

O widget também suporta configuração remota através da API do TAU. Estes parâmetros são carregados automaticamente do servidor e sobrepõem a configuração local:

should_load_widget boolean remoto

Controla se o widget deve ser carregado ou não. Útil para desabilitar o widget temporariamente.

// Controlado pela API TAU automaticamente
callout_text string remoto

Texto exibido no balão de chamada próximo ao botão do chat.

// Exemplo: "Olá! Como posso ajudar?"
enable_callout boolean remoto

Define se o balão de chamada deve ser exibido.

// Controlado pela configuração do bot no dashboard
chatbot_button_open_state_svg string remoto

SVG customizado para o ícone do botão quando o chat está aberto (configurado remotamente).

// Sobrepõe chatbotButtonOpenStateSVG local
chatbot_button_closed_state_svg string remoto

SVG customizado para o ícone do botão quando o chat está fechado (configurado remotamente).

// Sobrepõe chatbotButtonClosedStateSVG local
chatbot_button_background string remoto

Cor de fundo do botão definida remotamente via dashboard.

// Sobrepõe chatbotButtonBackground local
chatbot_button_foreground string remoto

Cor do ícone do botão definida remotamente via dashboard.

// Sobrepõe chatbotButtonForeground local

💎 Funcionalidades Premium

star Override de Configuração Remota via URL

Recurso exclusivo para assinantes premium que permite que parâmetros da URL sobrescrevam configurações remotas.

allow_url_params_override boolean premium

Quando ativado no dashboard premium, permite que parâmetros da URL tenham prioridade sobre configurações remotas para elementos visuais.

// Configurado no dashboard TAU (não via código)
// Permite URLs como: 
// site.com?chatbotButtonBackground=#FF0000&chatbotButtonOpenStateSVG=...

🔧 Como Ativar (Premium)

  1. Acesse o dashboard do TAU
  2. Vá para a seção "Integração do Site"
  3. Localize "Configuração Avançada de URL"
  4. Ative o toggle "Permitir personalização via parâmetros da URL"
  5. Agora parâmetros da URL poderão sobrescrever configurações remotas

📋 Parâmetros que Podem ser Sobrescritos

🌟 Casos de Uso Premium

Personalização por Campanha:

https://meusite.com/promocao?chatbotButtonBackground=#FF6B35&chatbotButtonOpenStateSVG=[SVG_CUSTOMIZADO]

Temas Sazonais:

https://meusite.com/natal?chatbotButtonBackground=#C41E3A&chatbotButtonForeground=#FFFFFF
security Segurança Premium

Esta funcionalidade é controlada pelo backend do TAU. Apenas usuários com assinatura premium podem ativar este recurso através do dashboard oficial.

cloud Prioridade de Configuração

Usuários Premium (com override ativado): Local → URL → Remoto → URL (novamente)
Usuários Padrão: Local → URL → Remoto (sempre prioridade)

lightbulb Dica de Configuração

Você não precisa definir todos os parâmetros. O widget funciona perfeitamente apenas com o appId. Configure apenas os parâmetros que deseja personalizar.