Pular para o conteúdo principal
POST
/
api
/
v1
/
messages
Criar uma nova mensagem
curl --request POST \
  --url https://6827d740d717.ngrok-free.app/api/v1/messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "API",
  "mediaType": "TEXT",
  "content": "Olá! Como posso ajudá-lo hoje?",
  "phone": "+5511999999999",
  "instanceIds": [
    "inst_1694024400000_xyz123456",
    "inst_1694024400000_abc789012"
  ],
  "mediaUrl": "https://exemplo.com/imagem.jpg",
  "metadata": {
    "origem": "dashboard",
    "campanha": "promocao-verao"
  }
}
'
{
  "id": "msg_1694024400000_xyz123456",
  "teamId": "tm_1694024400000_xyz123456",
  "type": "API",
  "mediaType": "TEXT",
  "sendStatus": "SENT",
  "content": "Olá! Como posso ajudá-lo hoje?",
  "phone": "+5511999999999",
  "createdAt": "2023-09-06T20:00:00.000Z",
  "mediaUrl": "https://exemplo.com/imagem.jpg",
  "instanceId": "inst_1694024400000_xyz123456",
  "history": [
    {
      "status": "PENDING",
      "timestamp": "2023-09-06T20:00:00.000Z"
    }
  ],
  "metadata": {
    "origem": "dashboard",
    "campanha": "promocao-verao"
  },
  "sentAt": "2023-09-06T20:00:00.000Z",
  "updatedAt": "2023-09-06T20:00:00.000Z"
}

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Corpo

application/json
​
type
enum<string>
obrigatório

Tipo da mensagem

Opções disponíveis:
API,
BATCH
Exemplo:

"API"

​
mediaType
enum<string>
obrigatório

Tipo de mídia da mensagem

Opções disponíveis:
TEXT,
IMAGE,
VIDEO,
DOCUMENT,
AUDIO
Exemplo:

"TEXT"

​
content
string
obrigatório

Conteúdo da mensagem

Exemplo:

"Olá! Como posso ajudá-lo hoje?"

​
phone
string
obrigatório

Número de telefone do destinatário

Exemplo:

"+5511999999999"

​
instanceIds
string[]
obrigatório

IDs das instâncias do WhatsApp para distribuição

Exemplo:
[
  "inst_1694024400000_xyz123456",
  "inst_1694024400000_abc789012"
]
​
mediaUrl
string

URL da mídia (para mensagens não-texto)

Exemplo:

"https://exemplo.com/imagem.jpg"

​
metadata
object

Metadados adicionais da mensagem

Exemplo:
{
  "origem": "dashboard",
  "campanha": "promocao-verao"
}

Resposta

Mensagem criada com sucesso

​
id
string
obrigatório

ID da mensagem

Exemplo:

"msg_1694024400000_xyz123456"

​
teamId
string
obrigatório

ID do time

Exemplo:

"tm_1694024400000_xyz123456"

​
type
enum<string>
obrigatório

Tipo da mensagem

Opções disponíveis:
API,
BATCH
Exemplo:

"API"

​
mediaType
enum<string>
obrigatório

Tipo de mídia da mensagem

Opções disponíveis:
TEXT,
IMAGE,
VIDEO,
DOCUMENT,
AUDIO
Exemplo:

"TEXT"

​
sendStatus
enum<string>
obrigatório

Status de envio da mensagem

Opções disponíveis:
PENDING,
IN_QUEUE,
SENT,
FAILED,
CANCELLED
Exemplo:

"SENT"

​
content
string
obrigatório

Conteúdo da mensagem

Exemplo:

"Olá! Como posso ajudá-lo hoje?"

​
phone
string
obrigatório

Número de telefone do destinatário

Exemplo:

"+5511999999999"

​
createdAt
string<date-time>
obrigatório

Data de criação da mensagem

Exemplo:

"2023-09-06T20:00:00.000Z"

​
mediaUrl
string

URL da mídia (para mensagens não-texto)

Exemplo:

"https://exemplo.com/imagem.jpg"

​
instanceId
string

ID da instância do WhatsApp

Exemplo:

"inst_1694024400000_xyz123456"

​
history
object

Histórico de status da mensagem

Exemplo:
[
  {
    "status": "PENDING",
    "timestamp": "2023-09-06T20:00:00.000Z"
  }
]
​
metadata
object

Metadados adicionais da mensagem

Exemplo:
{
  "origem": "dashboard",
  "campanha": "promocao-verao"
}
​
sentAt
string<date-time>

Data de envio da mensagem

Exemplo:

"2023-09-06T20:00:00.000Z"

​
updatedAt
string<date-time>

Data de atualização da mensagem

Exemplo:

"2023-09-06T20:00:00.000Z"