Skip to main content
POST
/
send-link
Enviar link
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "message": "Confira nosso site: https://www.hubmessage.io",
  "image": "https://www.hubmessage.io/logo.png",
  "linkUrl": "https://www.hubmessage.io",
  "title": "Hub Message",
  "linkDescription": "API Omnichannel para Comunicação Empresarial"
}
'
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

Overview

Method for sending messages with link preview, including image, title, and description.
Links are only clickable if the recipient has your number saved in their contacts or has previously started a conversation with you.
The response structure is identical to Z-API. Your existing code that processes these returns will continue working without changes.

Authorizations

Authorization
string
header
required

Secret Key gerada no painel de Segurança do Hub Message

Body

application/json
phone
string
required

Telefone do destinatário (DDI + DDD + número)

Example:

"5511999999999"

message
string
required

Texto da mensagem. Deve incluir a URL do link ao final

image
string
required

URL da imagem de preview do link

URL do link

title
string
required

Título do link

Descrição do link

Tamanho do preview: SMALL, MEDIUM ou LARGE

Available options:
SMALL,
MEDIUM,
LARGE
delayMessage
integer

Delay em segundos antes do envio (1-15)

Required range: 1 <= x <= 15
delayTyping
integer

Tempo em segundos exibindo status "digitando" (1-15)

Required range: 1 <= x <= 15

Response

Mensagem enviada com sucesso

zaapId
string

Identificador interno

messageId
string

ID da mensagem no WhatsApp

id
string

Mesmo valor do messageId (compatibilidade)