Status
Publicar status de imagem
Publica um status de imagem com legenda opcional.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/status/image" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"url":"https://.../status.jpg","caption":"Legenda"}'
const response = await fetch('https://seu-dominio/instances/:id/status/image', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"url": "https://.../status.jpg",
"caption": "Legenda"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Publica um status de imagem com legenda opcional.
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
url
string
opcional
URL HTTPS pública da mídia. Obrigatória no envio pela fila.
caption
string
opcional
Legenda opcional para imagem, vídeo ou documento.
Payload
Request Body
{
"url": "https://.../status.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.