Compatibilidade
Alias Z-API para envio de imagem
Alias Z-API para enviar imagem por URL ou base64.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/token/:token/send-image" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"phone":"5511999999999","image":"https://.../foto.jpg","caption":"Legenda"}'
const response = await fetch('https://seu-dominio/instances/:id/token/:token/send-image', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"phone": "5511999999999",
"image": "https://.../foto.jpg",
"caption": "Legenda"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Alias Z-API para enviar imagem por URL ou base64.
O token na URL é a API key do workspace ou a chave mestra. Por aparecer em logs de acesso, use HTTPS e migre para as rotas nativas quando possível.
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.
Client-Token
string
opcional
Opcional. Quando enviado, precisa pertencer ao mesmo workspace.
Path
id
string
obrigatório
ID da instância.
token
string
obrigatório
API key do workspace ou chave mestra.
Body
phone
string
obrigatório
Telefone com DDI e DDD, apenas dígitos ou no formato exibido.
image
string
obrigatório
URL HTTPS ou base64 da imagem.
caption
string
opcional
Legenda opcional para imagem, vídeo ou documento.
Payload
Request Body
{
"phone": "5511999999999",
"image": "https://.../foto.jpg",
"caption": "Legenda"
}
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.