Pular para o conteúdo principal

Ogmma API

Bem-vindo

Bem-vindo a documentacao da Ogmma API -- a plataforma completa para envio e gerenciamento de mensagens WhatsApp via API REST.

Com a Ogmma API voce consegue integrar o WhatsApp ao seu sistema de forma simples e rapida. Seja para enviar notificacoes, automatizar atendimento ou gerenciar conversas em escala, a API foi projetada para facilitar sua vida como desenvolvedor.


O que voce pode fazer

Com a Ogmma API, voce tem acesso a:

  • Envio de mensagens -- texto, imagem, video, audio, documento, contato e localizacao
  • Envio em massa -- dispare mensagens para multiplos contatos de uma so vez
  • Webhooks -- receba notificacoes em tempo real sobre mensagens recebidas, enviadas, lidas e mais
  • Sandbox -- teste suas integracoes sem precisar de um numero WhatsApp real
  • Gerenciamento de conversas -- acompanhe, atribua e transfira conversas entre atendentes
  • Gerenciamento de contatos -- crie e organize sua base de contatos
  • Templates WABA -- envie mensagens aprovadas pelo Meta para canais oficiais
  • Interface de atendimento -- plataforma web completa para atendimento ao cliente
  • Integracoes N8N -- automatize workflows de envio e recebimento de mensagens

URLs Base

AmbienteURL Base
Producaohttps://oapi.ogmma.com.br/v1
Dica

Para testes e desenvolvimento, use uma API Key de teste (prefixo oapi_sk_test_) com os endpoints do Sandbox. A URL base e a mesma -- o ambiente e determinado pela chave.


Exemplo Rapido

Quer ver como e simples? Veja como enviar uma mensagem de texto com um unico comando:

Metodo

POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/text

KeyValue
AuthorizationBearer {sua-api-key}
Content-Typeapplication/json

Request Body

{
"to": "5511999999999",
"text": "Ola! Esta e uma mensagem enviada pela Ogmma API."
}

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/text" \
-H "Authorization: Bearer oapi_sk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{
"to": "5511999999999",
"text": "Ola! Esta e uma mensagem enviada pela Ogmma API."
}'

Response

202 - Aceito

{
"success": true,
"message": "Mensagem enfileirada para envio"
}
Nota

O status 202 Accepted indica que a mensagem foi aceita para processamento. O envio efetivo acontece de forma assincrona pelo Worker. Voce pode acompanhar o status via Webhooks.


Proximos Passos

Pronto para comecar? Siga o guia:

  1. O que e o Ogmma API -- Entenda a plataforma e sua arquitetura
  2. Primeiros Passos -- Crie sua conta e envie sua primeira mensagem
  3. Autenticacao -- Configure suas API Keys e entenda as permissoes
  4. Integracoes com N8N -- Automatize workflows de envio e recebimento

Precisa de Ajuda?

Se voce tiver duvidas ou encontrar algum problema, entre em contato com nosso suporte ou abra uma issue no GitHub.