Skip to main content
POST
Send link

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.

Autorizações

Authorization
string
header
obrigatório

Secret Key generated in the Omni Z-API Security panel

Corpo

application/json
phone
string
obrigatório

Recipient phone number (country code + area code + number)

Exemplo:

"5511999999999"

message
string
obrigatório

Message text. Must include the link URL at the end

image
string
obrigatório

Link preview image URL

Link URL

title
string
obrigatório

Link title

Link description

Preview size: SMALL, MEDIUM or LARGE

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

Delay in seconds before sending (1-15)

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

Seconds to display "typing" status (1-15)

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

Resposta

Message sent successfully

zaapId
string

Internal identifier

messageId
string

WhatsApp message ID

id
string

Same value as messageId (compatibility)