Mensagens
Compartilha pedido
totalAmount1000 usa milésimos da moeda (R$23,90 = 23900).
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/messages/order" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"to":"5511999999999","orderId":"order-1","itemCount":1,"totalAmount1000":23900,"currency":"BRL","token":"TOKEN_DO_PEDIDO","sellerJid":"5511000000000@s.whatsapp.net","title":"Pedido"}'
const response = await fetch('https://seu-dominio/instances/:id/messages/order', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"to": "5511999999999",
"orderId": "order-1",
"itemCount": 1,
"totalAmount1000": 23900,
"currency": "BRL",
"token": "TOKEN_DO_PEDIDO",
"sellerJid": "5511000000000@s.whatsapp.net",
"title": "Pedido"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
totalAmount1000 usa milésimos da moeda (R$23,90 = 23900). Token e dados comerciais precisam ser fornecidos pelo integrador.
A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.
Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
content-type
string
obrigatório
application/json.
Path
id
string
obrigatório
ID da instância.
Body
to
string
opcional
Telefone com DDI e DDD, ou JID de grupo terminando em @g.us.
orderId
string
opcional
Campo orderId do corpo JSON.
itemCount
integer
opcional
Campo itemCount do corpo JSON.
totalAmount1000
integer
opcional
Campo totalAmount1000 do corpo JSON.
currency
string
opcional
Campo currency do corpo JSON.
token
string
opcional
Campo token do corpo JSON.
sellerJid
string
opcional
Campo sellerJid do corpo JSON.
title
string
opcional
Campo title do corpo JSON.
Payload
Request Body
{
"to": "5511999999999",
"orderId": "order-1",
"itemCount": 1,
"totalAmount1000": 23900,
"currency": "BRL",
"token": "TOKEN_DO_PEDIDO",
"sellerJid": "5511000000000@s.whatsapp.net",
"title": "Pedido"
}
Contrato
200
Resposta
{
"data": {
"ok": true
}
}
Respostas de sucesso são envelopadas em data.
Erros comuns
400
Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401
Credencial ausente, inválida ou sessão expirada.
403
Escopo insuficiente, IP não autorizado ou workspace suspenso.
404
Recurso não encontrado ou pertence a outro workspace.
409
Instância não conectada ou conflito de estado.