Skip to main content
POST
/
api
/
send
/
link-custom-preview
Enviar uma mensagem de texto com prévia de link PERSONALIZADA
curl --request POST \
  --url https://{host}/api/send/link-custom-preview \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "chatId": "[email protected]",
  "text": "Check this out! https://github.com/",
  "preview": {
    "url": "https://github.com/",
    "title": "Your Title",
    "description": "Check this out, amazing!",
    "image": {
      "url": "https://github.com/stgcompany/wappfy/raw/core/examples/wappfy.jpg"
    }
  },
  "session": "my-session",
  "reply_to": null,
  "linkPreviewHighQuality": true
}
'
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Descrição

Este endpoint permite enviar mensagens com links que incluem previews customizados. Você pode definir o título, descrição e imagem que aparecerão no preview do link, em vez de usar o preview automático do WhatsApp.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]",
  "text": "Olá, como vai?",
  "preview": {
    "url": "https://exemplo.com",
    "title": "Título",
    "description": "Descrição",
    "image": "valor"
  }
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
sessionIdstring✅ SimID da sessão autenticada que enviará a mensagem
jidstring✅ SimIdentificador do destinatário (JID do WhatsApp). Formato: [email protected] para contatos ou [email protected] para grupos
textstring✅ SimTexto da mensagem que acompanha o link
previewobject✅ SimObjeto contendo as informações do preview customizado
preview.urlstring✅ SimURL do link
preview.titlestring✅ SimTítulo que aparecerá no preview
preview.descriptionstring✅ SimDescrição que aparecerá no preview
preview.imagestring❌ NãoImagem do preview codificada em base64
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Códigos de Status

  • 200 - Link com preview customizado enviado com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/send/link-custom-preview \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]",
    "text": "Confira nossa promoção especial!",
    "preview": {
      "url": "https://exemplo.com/promocao",
      "title": "Promoção Especial - 50% OFF",
      "description": "Aproveite descontos incríveis em todos os produtos",
      "image": "iVBORw0KGgoAAAANSUhEUgA..."
    }
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Body

application/json
​
chatId
string
required
​
text
string
default:Check this out! https://github.com/
required

Texto da mensagem. DEVE incluir a URL fornecida em preview.url

​
preview
object
required
​
session
string
required

Nome da sessão (instanceName)

Example:

"my-session"

​
reply_to
string

ID da mensagem à qual você deseja responder

Example:

null

​
linkPreviewHighQuality
boolean
default:true

Response

201 - application/json

The response is of type object.