Pular para o conteúdo principal
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"
}

Conceituação

Método para envio de mensagens com preview de link, incluindo imagem, título e descrição.
Os links só são clicáveis se o destinatário tiver seu número salvo na agenda ou se ele tiver iniciado uma conversa com você anteriormente.
A estrutura de resposta é idêntica à da Z-API. Seu código existente que processa esses retornos continuará funcionando sem alterações.

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
phone
string
obrigatório

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

Exemplo:

"5511999999999"

message
string
obrigatório

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

image
string
obrigatório

URL da imagem de preview do link

URL do link

title
string
obrigatório

Título do link

Descrição do link

Tamanho do preview: SMALL, MEDIUM ou LARGE

Opções disponíveis:
SMALL,
MEDIUM,
LARGE
delayMessage
integer

Delay em segundos antes do envio (1-15)

Intervalo obrigatório: 1 <= x <= 15
delayTyping
integer

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

Intervalo obrigatório: 1 <= x <= 15

Resposta

Mensagem enviada com sucesso

zaapId
string

Identificador interno

messageId
string

ID da mensagem no WhatsApp

id
string

Mesmo valor do messageId (compatibilidade)