vértice
Produto Preços Painel
Status

Responde a um status com GIF

Responde a um status com GIF.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/status/reply/gif" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"jid":"5511999999999","messageId":"ABC","url":"https://.../gif.mp4"}'
POST /instances/{id}/status/reply/gif
API key
Entenda

Conceituação

Responde a um status com GIF.

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

jid string opcional

JID do contato ou grupo. Necessário quando a mensagem não está mais no cache.

messageId string opcional

ID da mensagem retornado pelo WhatsApp.

url string opcional

URL HTTPS pública da mídia. Obrigatória no envio pela fila.

Payload

Request Body

{
  "jid": "5511999999999",
  "messageId": "ABC",
  "url": "https://.../gif.mp4"
}
Contrato

Resposta

200
{
  "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.