ZapFácil zapfacil.dev Doc
Entrar Painel
Doc AI Friendly (agente de IA)

Enviar Imagem

Envia um arquivo de imagem com legenda opcional para um número de WhatsApp. Formatos suportados: JPG, PNG, WEBP. Você pode enviar a imagem como uma URL pública ou uma string codificada em Base64.

POST /instances/{instance_id}/send-image
Exemplo Completo (Payload) 
{
  "phone": "5511999999999",
  "image": "https://zapfacil.dev/images/logo/zapfacil_logo_z.webp",
  "caption": "Logotipo do ZapFácil",
  "viewOnce": false,
  "delayBetweenMessages": 2
}

Headers

Authorization string header required

Token de autenticação da empresa no formato Bearer <token_empresa>.

X-Instance-Token string header required

Token secreto exclusivo da instância.

Content-Type string header required

Deve ser application/json.

Path Parameters

instance_id string (uuid) path required

ID único da instância (UUIDv7) enviado no caminho da URL.

Body Payload

application/json
phone string required

Número do destinatário com DDI e DDD (apenas números, de 12 a 15 dígitos, sem o símbolo +).

image string required

URL pública ou imagem codificada em string Base64.

caption string

Texto de legenda da imagem. (Máx: 4096 caracteres)

viewOnce boolean

Se verdadeiro, define a imagem como de visualização única.

delayBetweenMessages integer

Tempo de envio entre as mensagens. (Mín: 1, Máx: 15)

Response Schema

application/json
success boolean required

Indica se a requisição foi aceita.

error string | null required

Detalhes de falhas (null em caso de sucesso).

data object | null

Informações do envio (pode ser null em alguns casos).

Atributos do Objeto
zapFacilId string (uuid)

Identificador único da mensagem no ZapFácil.

whatsappId string

ID da mensagem gerado na rede do WhatsApp.

{
  "success": true,
  "data": {
    "zapFacilId": "019e059f-d16a-7bf1-a1b6-26293e8a05f1",
    "whatsappId": "3EB0BC9B8E580F7E618"
  },
  "error": null
}