Instâncias
Limpar cache de mídia da instância
Restrito a gestor/máquina; confirm=true obrigatório.
API key
Escopo write
Exemplo de requisição
curl -X DELETE "https://seu-dominio/instances/:id/media" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"confirm":true}'
const response = await fetch('https://seu-dominio/instances/:id/media', {
method: 'DELETE',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"confirm": true
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Restrito a gestor/máquina; confirm=true obrigatório. Preserva instância, histórico e credenciais.
Envio síncrono devolve o ID da mensagem imediatamente. Com queue, delayMessage, delayTyping ou idempotencyKey, a resposta é 202 e o job pode ser acompanhado em /instances/:id/queue.
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
confirm
boolean
opcional
Campo confirm do corpo JSON.
Payload
Request Body
{
"confirm": true
}
Contrato
204
Resposta
A operação responde 204 sem corpo.
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.