Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
send-link
curl --request POST \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/send-link \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "{{PHONE}}",
  "message": "Mensagem que irà aparecer antes do link",
  "image": "https://images.unsplash.com/photo-1519125323398-675f0ddb6308?auto=format&fit=crop&w=1200&q=80",
  "linkUrl": "https://www.wikipedia.org",
  "title": "Título da mensagem",
  "linkDescription": "description"
}
'
{
  "messageId": "3EB047ED70306656281B34",
  "id": "3EB047ED70306656281B34"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ezapi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Envia um link com texto complementar e prévia quando disponível.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Body

application/json
​
phone
string
required

Número com código do país (ex: 554499999999) ou JID de grupo (ex: 120363123456789@g.us)

Example:

"{{PHONE}}"

​
message
string
required
Example:

"Mensagem que irà aparecer antes do link"

​
image
string
required
Example:

"https://images.unsplash.com/photo-1519125323398-675f0ddb6308?auto=format&fit=crop&w=1200&q=80"

​
linkUrl
string
required
Example:

"https://www.wikipedia.org"

​
title
string
required
Example:

"Título da mensagem"

​
linkDescription
string
required
Example:

"description"

​
mentioned
string[]

Lista de números para mencionar em grupos

Example:
["554499999999"]
​
mentionsEveryOne
boolean
default:false

Mencionar todos os participantes do grupo

Response

Resposta de sucesso.

​
messageId
string
required
Example:

"3EB047ED70306656281B34"

​
id
string
required
Example:

"3EB047ED70306656281B34"