Conversas
Arquiva, fixa, muta, lê ou expira o chat
Combina arquivamento, fixação, mudo, leitura e expiração em uma chamada.
API key
Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/chats/:jid" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"archive":true,"pin":false,"muteSeconds":3600,"read":true,"expirationSeconds":86400}'
const response = await fetch('https://seu-dominio/instances/:id/chats/:jid', {
method: 'PATCH',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"archive": true,
"pin": false,
"muteSeconds": 3600,
"read": true,
"expirationSeconds": 86400
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Combina arquivamento, fixação, mudo, leitura e expiração em uma chamada.
Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.
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.
jid
string
obrigatório
JID do grupo terminando em @g.us.
Body
archive
boolean
opcional
Campo archive do corpo JSON.
pin
boolean
opcional
Campo pin do corpo JSON.
muteSeconds
integer
opcional
Campo muteSeconds do corpo JSON.
read
boolean
opcional
Campo read do corpo JSON.
expirationSeconds
integer
opcional
Campo expirationSeconds do corpo JSON.
Payload
Request Body
{
"archive": true,
"pin": false,
"muteSeconds": 3600,
"read": true,
"expirationSeconds": 86400
}
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.