post
https://api.inngage.com.br/v4/createMessage/-1
Envio de mensagens utilizando API Templates. Este recurso permitirá a troca de campos chave pelo conteúdo informado, promovendo maior flexibilidade e desacoplamento da integração.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
API de Mensagem — v4 (createMessage)
Documentação do módulo createMessage, que cria uma mensagem (push, SMS, WhatsApp, e-mail, RCS, in-app, on-site ou multicanal), persistindo um documento control_message no MongoDB e os destinatários no MariaDB. Suporta agendamento, envio imediato (instant_message), campanhas, templates de API e fluxo de aprovação.
| Endpoint | O que faz |
|---|---|
POST /v4/createMessage/ | Cria e agenda (ou dispara na hora) uma mensagem multicanal |
Autenticação
app_tokenobrigatório no corpo — resolvido no MariaDB (app); inválido → 401.- JWT condicional: se o app tiver token ativo em
app_auth_token, o headerAuthorizationpassa a ser obrigatório (ausente ou"undefined"→ 403). Se o app não tem JWT ativo, o header é ignorado.
Respostas
Shape sempre { "saveResponse": { "status": <n>, "details": <...> } }.
Sucesso — 200. O details varia por fluxo:
| Fluxo | details |
|---|---|
| instant | { "CM_id": "<id>", "message": "Message created and directed to the delivery queue." } ou "Message created and pending approval." |
| identifiers | { "control": "<id>", "recipients": <total> } |
| audience | { "control": "<id>", "Audiences": [<id>] } |
| subscriber_id | { "control": "<id>", "recipients": [...] } |
bulk (origin: 4) | { "control": "<id>", "recipients": <identifiers> } |
| fallback "all" | { "control": "<id>", "recipients": "all" } |
| template | resultado único ou array (um por identifier) |
Erros:
| Status | Quando | details |
|---|---|---|
| 400 | validação Zod, payload vazio, app_token ausente ou ValidationError | mensagem do erro (ex.: "Invalid payload. Check your JSON.", "app_token is required.") |
| 401 | app_token inválido | "Invalid App Token." |
| 403 | app com JWT ativo sem header Authorization | "Forbidden, check your authorization!" |
| 500 | DomainError ou erro inesperado | mensagem do erro ou "Internal Server Error" |
Exemplos
Push agendado para lista de identifiers:
{
"app_token": "a1b2c3d4e5f6",
"title": "Promoção relâmpago",
"body": "Aproveite 30% OFF só hoje!",
"image": "https://cdn.exemplo.com/promo.png",
"url": "https://loja.exemplo.com/ofertas",
"channel_id": 1,
"identifiers": ["user-123", "user-456"],
"schedule": "2026-07-08 09:00:00",
"expiration_period": 24,
"expiration_period_type": "hours",
"utm_source": "push"
}Envio instant de 2FA por SMS:
{
"app_token": "a1b2c3d4e5f6",
"body": "Seu código de acesso é 4821",
"instant_message": true,
"phone_number": "+55 11 99999-8888",
"authentication_code": "4821",
"channel_id": 2
}Formato V1 (legado):
{
"sendPushRequest": {
"app_token": "a1b2c3d4e5f6",
"identifier": "user-123",
"title": "Olá",
"message": "Bem-vindo de volta!"
}
}