Pular para o conteúdo principal

Mensagens

Conceituacao​

As mensagens sao o nucleo da comunicacao na plataforma Ogmma. Atraves da API, voce pode enviar diferentes tipos de mensagens, consultar historicos e interagir com mensagens existentes.

Tipos de Mensagem​

TipoDescricaoBaileysWABA
textMensagem de texto simplesSimSim
imageImagem com legenda opcionalSimSim
videoVideo com legenda opcionalSimSim
audioAudio ou mensagem de vozSimSim
documentDocumento/arquivoSimSim
contactCartao de contatoSimSim
buttonsMensagem com botoes interativosSimNao
templateMensagem de template aprovadoNaoSim

Direcao da Mensagem​

DirecaoDescricao
OUTBOUNDMensagem enviada pela API (de voce para o destinatario).
INBOUNDMensagem recebida do destinatario (pode ser capturada via webhook).

Ciclo de Vida da Mensagem​

Toda mensagem enviada passa por uma sequencia de status:

QUEUED → SENT → DELIVERED → READ
StatusDescricao
QUEUEDMensagem recebida pela API e adicionada a fila de envio.
SENTMensagem enviada com sucesso ao WhatsApp.
DELIVEREDMensagem entregue no dispositivo do destinatario.
READMensagem lida pelo destinatario.
FAILEDFalha no envio da mensagem.

Processamento Sequencial​

As mensagens sao enfileiradas no Redis e processadas sequencialmente por conversa. Isso garante que:

  • A ordem das mensagens e preservada.
  • Nao ha condicoes de corrida entre mensagens da mesma conversa.
  • Mensagens para conversas diferentes sao processadas em paralelo.

Formato do Numero de Telefone​

O campo to (destinatario) deve seguir o formato internacional completo:

DDI + DDD + NUMERO

Exemplos:

  • Brasil: 5511999998888 (55 = DDI, 11 = DDD, 999998888 = numero)
  • Portugal: 351912345678
Importante

Nao inclua o caractere +, espacos ou hifens no numero. Utilize apenas digitos.

Estrutura da Mensagem​

{
"id": "6650a1b2c3d4e5f6a7b8c9d0",
"conversationId": "6650a1b2c3d4e5f6a7b8c9d1",
"channelId": "6650a1b2c3d4e5f6a7b8c9d2",
"type": "text",
"direction": "OUTBOUND",
"status": "DELIVERED",
"content": "Ola! Como posso ajudar?",
"mediaUrl": null,
"from": "5511999998888",
"to": "5511977776666",
"quotedMessageId": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:05.000Z"
}