Configurações
Atualizar auto-leitura, chamadas e proteção de grupos
Atualiza auto-leitura de mensagens/status, rejeição automática de chamadas, mensagem de rejeição e announcement guard.
API key
Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/settings" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"autoReadMessages":true,"autoReadStatus":true,"autoRejectCalls":true,"callRejectMessage":"Não posso atender agora.","announcementGuard":true}'
const response = await fetch('https://seu-dominio/instances/:id/settings', {
method: 'PATCH',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"autoReadMessages": true,
"autoReadStatus": true,
"autoRejectCalls": true,
"callRejectMessage": "Não posso atender agora.",
"announcementGuard": true
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Atualiza auto-leitura de mensagens/status, rejeição automática de chamadas, mensagem de rejeição e announcement guard.
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.
Body
autoReadMessages
boolean
opcional
Campo autoReadMessages do corpo JSON.
autoReadStatus
boolean
opcional
Campo autoReadStatus do corpo JSON.
autoRejectCalls
boolean
opcional
Campo autoRejectCalls do corpo JSON.
callRejectMessage
string
opcional
Campo callRejectMessage do corpo JSON.
announcementGuard
boolean
opcional
Campo announcementGuard do corpo JSON.
Payload
Request Body
{
"autoReadMessages": true,
"autoReadStatus": true,
"autoRejectCalls": true,
"callRejectMessage": "Não posso atender agora.",
"announcementGuard": true
}
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.