Pular para o conteúdo principal

Canais

Conceituacao

Um canal representa uma conexao WhatsApp ativa na plataforma Ogmma. Cada canal corresponde a um numero de telefone conectado que pode enviar e receber mensagens.

A Ogmma suporta dois tipos de canais:

TipoDescricaoConexao
WHATSAPP_BAILEYSWhatsApp via protocolo BaileysLeitura de QR Code pelo celular
WHATSAPP_WABAWhatsApp Business API (Meta)Credenciais da API do Meta Business

Status do Canal

Cada canal possui um status que indica o estado atual da conexao:

StatusDescricao
CONNECTEDCanal conectado e operacional. Pronto para enviar e receber mensagens.
DISCONNECTEDCanal desconectado. Necessita reconexao para operar.
AWAITING_QRAguardando leitura do QR Code (apenas Baileys).

Estrutura do Canal

{
"id": "6650a1b2c3d4e5f6a7b8c9d0",
"name": "Atendimento Principal",
"type": "WHATSAPP_BAILEYS",
"status": "CONNECTED",
"phone": "5511999998888",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z"
}

Limites

  • Cada instituicao pode ter multiplos canais conectados simultaneamente.
  • Canais do tipo WHATSAPP_BAILEYS requerem que o celular permaneca conectado a internet.
  • Canais do tipo WHATSAPP_WABA operam de forma independente, sem necessidade do celular.

Fluxo Tipico

  1. Criar canal - Registre um novo canal com nome e tipo.
  2. Conectar canal - Escaneie o QR Code (Baileys) ou fornecea credenciais (WABA).
  3. Enviar/Receber mensagens - Utilize os endpoints de mensagens com o channelId.
  4. Monitorar status - Acompanhe a saude do canal via endpoint de status.
Dica

Para ambientes de teste, recomendamos utilizar o canal do tipo WHATSAPP_BAILEYS por ser mais simples de configurar. Para producao em escala, utilize WHATSAPP_WABA.