Exemplo de requisição
curl -X GET "https://seu-dominio/instances/:id/contacts/:jid/picture" \
-H "x-api-key: $VERTICE_API_KEY"const response = await fetch('https://seu-dominio/instances/:id/contacts/:jid/picture', {
method: 'GET',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
},
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Retorna a URL da foto do contato.
Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
Path
id
string
obrigatório
ID da instância.
jid
string
obrigatório
JID do grupo terminando em @g.us.
Contrato
200
Resposta
{
"data": {
"id": "..."
}
}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.