Enviar coleção de catálogo
Protocolo nativo pela sessão conectada, sem serviço externo.
curl -X POST "https://seu-dominio/instances/:id/messages/catalog/collection" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"to":"5511999999999","text":"Coleção","businessJid":"5511999999999@s.whatsapp.net","collectionId":"ID_COLECAO"}'
const response = await fetch('https://seu-dominio/instances/:id/messages/catalog/collection', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"to": "5511999999999",
"text": "Coleção",
"businessJid": "5511999999999@s.whatsapp.net",
"collectionId": "ID_COLECAO"
}),
});
const payload = await response.json();
console.log(payload);
Conceituação
Protocolo nativo pela sessão conectada, sem serviço externo. Retorna experimental=true; aceitação pelo relay não comprova entrega ou renderização. quotedMessageId opcional cita uma mensagem recente do mesmo chat. Mídia usa URL permitida ou base64.
A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.
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.
text
string
opcional
Corpo da mensagem. Respeite o limite de 65.536 caracteres.
businessJid
string
opcional
Campo businessJid do corpo JSON.
collectionId
string
opcional
Campo collectionId do corpo JSON.
Request Body
{
"to": "5511999999999",
"text": "Coleção",
"businessJid": "5511999999999@s.whatsapp.net",
"collectionId": "ID_COLECAO"
}
Resposta
{
"data": {
"ok": true
}
}
Respostas de sucesso são envelopadas em data.