Documentação técnica do RitmaChat

Comece aqui

Como usar esta documentação

Use esta área como manual de implantação e operação. Cada página resolve um assunto específico e aponta para a tela real da plataforma quando existir uma rota direta.

Ordem recomendada de implantação

Revise plano, usuários e permissões do workspace.
Crie departamentos antes de conectar o primeiro número.
Defina política de atendimento, expediente, SLA e motivos de encerramento.
Provisione ou cadastre uma instância WhatsApp.
Conecte o número por QR Code ou código de pareamento.
Configure departamento padrão e teste regras de roteamento.
Sincronize etiquetas, respostas rápidas, grupos e recursos do canal que serão usados.
Cadastre tags locais, campos personalizados e teste a tela de conversas.
Crie chatbots, publique uma versão e acompanhe execuções.
Ative webhooks, regras, campanhas e recursos avançados apenas depois do teste operacional.

Print reservado Painel inicial ou visão geral do workspace Imagem real sugerida: dashboard com indicadores de atendimento.

Use este espaço para orientar visualmente onde a implantação começa.

Mapa do sistema

Áreas principais da plataforma

Os links abaixo são rotas reais do RitmaChat. Páginas protegidas exigem login e workspace ativo.

Atendimento Conversas Inbox, protocolo, mensagens, transferência, etiquetas e CRM do atendimento. Workspace Equipe Usuários, papéis, convites, reset de senha, status e limite do plano. Filas Departamentos Filas operacionais, membros, supervisores e expediente por área. Entrada Roteamento Regras, prioridade, relações entre workspaces e teste de destino. Configuração Instâncias Números WhatsApp, conexão, QR Code, diagnóstico, webhooks e perfil. Organização Etiquetas Sincronização e consulta de labels WhatsApp por instância. CRM Clientes Diretório de clientes, tags locais, campos personalizados e exportação. Mídias Arquivos Biblioteca de imagens, áudios e documentos recebidos nas conversas. Automação Chatbots Fluxos, editor visual, publicação, simulação e execuções. Integrações Webhooks externos Endpoints para receber eventos operacionais do RitmaChat. Ativo Campanhas Comunicação ativa, públicos, opt-out, fila de envio e exportação. Governança Plano Limites, recursos contratados, solicitações de alteração e capacidade. Controle Auditoria Eventos operacionais, rastreabilidade e investigação de mudanças.

Conceitos

Termos usados nos guias

Use a mesma nomenclatura nos treinamentos internos para reduzir erro de configuração.

Workspace: Ambiente da empresa. Contém usuários, plano, instâncias, departamentos, clientes, automações e auditoria.
Instância: Conexão entre um número de WhatsApp e o RitmaChat. Controla autenticação, status, webhook, fila de envio e sincronizações.
Conversa ou protocolo: Atendimento vinculado a cliente, número, instância, status, responsável e histórico.
Departamento: Fila lógica da operação, como Comercial, Suporte, Financeiro ou Implantação.
Política de conversa: Conjunto de regras do workspace para SLA, expediente, reabertura de protocolo e comportamento após janela.
Regra de roteamento: Critério que decide o departamento inicial da conversa por prioridade, instância, grupo ou origem.
Etiqueta WhatsApp: Label sincronizada do WhatsApp e aplicada ao chat por ID de etiqueta.
Tag local: Classificação própria do CRM do RitmaChat, independente das etiquetas do WhatsApp.
Chatbot: Fluxo publicado com nós, portas e transições. Pode responder, perguntar, consultar IA, chamar APIs, agendar mensagens e transferir para humano.
Webhook externo: Endpoint cadastrado para receber eventos ou ser acionado por automações do RitmaChat.
Campanha: Comunicação ativa com público, opt-out, fila de envio, acompanhamento de status e exportação.
Plano: Conjunto de limites e recursos que controla usuários, instâncias, envios, IA e funções avançadas.

Leitura por perfil

Por onde cada pessoa deve começar

Use este roteiro para treinamento interno, implantação e suporte.

Perfil	Guias prioritários	Objetivo
Gestão	Visão geral, equipe e roteamento, planos e governança.	Entender capacidade, papéis, filas, SLA e controle operacional.
Implantação	Instâncias, recursos da instância, etiquetas/CRM, integrações.	Colocar canal em produção com roteamento, webhook e diagnóstico prontos.
Atendimento	Atendimento, mensagens/mídia/IA, etiquetas/CRM.	Operar conversas, transferir, registrar contexto e usar recursos do inbox.
Automação	Chatbots, nós do chatbot, integrações e regras.	Desenhar fluxos, validar portas, tratar falhas e acompanhar execuções.
Suporte técnico	Recursos da instância, campanhas/diagnóstico/segurança, integrações.	Investigar falhas sem expor credenciais ou alterar produção sem rastreio.