Guia técnico
Criar, conectar e operar instâncias WhatsApp
Passo a passo para provisionar número, parear WhatsApp, revisar roteamento e diagnosticar conexão.
Pré-requisitos
Antes de criar uma instância
Prepare departamento, permissões e decisão de roteamento antes de conectar o número. Isso evita conversas entrando sem fila ou sem responsável.
Você precisa ter
- Usuário administrador ou dono do workspace.
- Plano com limite disponível para nova instância.
- Departamento padrão definido para o canal.
- Celular com WhatsApp Business ativo e acesso a aparelhos conectados.
Links diretos
Criação
Criar uma instância automática
- Acesse Instâncias e clique em criar ou provisionar nova instância.
- Preencha um nome interno claro, como
Atendimento principal. - O identificador interno é criado automaticamente a partir do nome.
- Registre o responsável interno pelo canal, se a operação usar essa governança.
- Confirme a criação. O RitmaChat provisiona a instância no provedor e salva a credencial protegida.
- Após a criação, abra a tela da instância e avance para a aba de conexão.
Print reservado
Lista de instâncias
Imagem real sugerida: botão de nova instância e cards de status dos números.
Manual
Cadastrar uma instância já existente
Use o cadastro manual apenas quando a instância já existe no provedor e você recebeu os dados técnicos corretos.
| Campo | O que preencher | Cuidado operacional |
|---|---|---|
| Nome | Nome legível para a equipe. | Use padrão por área ou unidade, como Vendas SP. |
| ID na API | Identificador remoto da instância no provedor. | Precisa bater exatamente com o cadastro externo. |
| URL base | Endpoint base usado pela integração. | Não inclua credenciais na URL. |
| Token da instância | Credencial técnica de acesso ao provedor. | Nunca compartilhe em chat, print, commit ou documentação. |
| Departamento padrão | Fila inicial para conversas recebidas. | Sem departamento, novas conversas podem cair na entrada geral. |
| Ativa | Libera o uso operacional da instância. | Deixe desativada enquanto valida dados técnicos. |
Pareamento
Conectar por QR Code
- Abra Instâncias e entre na instância desejada.
- Na tela da instância, abra a aba ou ação de conexão.
- No formulário de pareamento, deixe o telefone vazio para gerar QR Code.
- Escolha o browser automático, salvo orientação técnica diferente.
- Opcionalmente preencha o nome do sistema que aparecerá como aparelho conectado no WhatsApp.
- Clique em gerar QR Code ou parear.
- No WhatsApp Business, abra aparelhos conectados e escaneie o QR Code.
- Atualize o status no RitmaChat até a instância aparecer como conectada.
Print reservado
Aba de conexão com QR Code
Imagem real sugerida: QR Code, status e botão de atualizar conexão.
Pareamento alternativo
Conectar por código com telefone
Use esta opção quando o provedor e o WhatsApp permitirem pareamento por código, sem leitura de QR Code.
- Na conexão da instância, preencha o telefone com DDI, DDD e número, apenas dígitos. Exemplo:
5511999999999. - Escolha browser e proxy regional apenas se sua operação exigir.
- Gere o pareamento e copie o código exibido.
- No WhatsApp Business, use a opção de conectar por número/código.
- Volte ao RitmaChat, atualize o status e confirme se o número conectado está correto.
Configuração de entrada
Roteamento, webhook e envio
Depois do pareamento, a instância ainda precisa estar preparada para receber, processar e responder conversas.
| Área | O que validar | Onde olhar |
|---|---|---|
| Departamento padrão | Destino de novas conversas quando nenhuma regra específica vencer. | Cadastro da instância e aba Roteamento. |
| Regras de roteamento | Prioridade, grupo, origem e destino operacional. | Roteamento e prévia de teste. |
| Webhook de entrada | URL esperada, status ativo, eventos recentes e falhas. | Aba Webhooks e eventos de webhook. |
| Fila de envio | Mensagens pendentes, falhas, cadência e limites remotos. | Aba Envio e fila da instância. |
| Perfil do canal | Nome, foto, business profile e recursos públicos. | Aba Perfil WhatsApp. |
| Diagnóstico | Status remoto, últimos erros, fila assíncrona e limites. | Aba Diagnóstico antes de qualquer reset. |
Pós-conexão
Checklist depois de conectar
Conexão ativa não significa operação pronta. Revise os itens abaixo antes de liberar atendimento em produção.
Configuração obrigatória
- Departamento padrão configurado na instância.
- Webhook de entrada funcionando sem erro recente.
- Status da instância conectado e sem fila assíncrona travada.
- Mensagem de teste recebida aparece em Conversas.
Se algo falhar
- Gere um novo QR Code se o anterior expirar.
- Desconecte sessões antigas do WhatsApp se houver conflito.
- Use diagnóstico da instância para checar webhook, status, limite e fila.
- Não recrie a instância antes de revisar logs e status remoto.