Send link with preview
curl --request POST \
--url https://api.zapfy.io/v1/messages/send-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "5511999998888",
"text": "<string>",
"url": "https://zapfy.io",
"title": "<string>",
"description": "<string>",
"imgUrl": "<string>",
"delay": 123
}
'import requests
url = "https://api.zapfy.io/v1/messages/send-link"
payload = {
"to": "5511999998888",
"text": "<string>",
"url": "https://zapfy.io",
"title": "<string>",
"description": "<string>",
"imgUrl": "<string>",
"delay": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '5511999998888',
text: '<string>',
url: 'https://zapfy.io',
title: '<string>',
description: '<string>',
imgUrl: '<string>',
delay: 123
})
};
fetch('https://api.zapfy.io/v1/messages/send-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zapfy.io/v1/messages/send-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '5511999998888',
'text' => '<string>',
'url' => 'https://zapfy.io',
'title' => '<string>',
'description' => '<string>',
'imgUrl' => '<string>',
'delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zapfy.io/v1/messages/send-link"
payload := strings.NewReader("{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zapfy.io/v1/messages/send-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapfy.io/v1/messages/send-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"messageId": "3EB0C767D4..."
}
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}Messages
Send link with preview
Sends a text with a link and a preview card (title, description and image).
POST
/
messages
/
send-link
Send link with preview
curl --request POST \
--url https://api.zapfy.io/v1/messages/send-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "5511999998888",
"text": "<string>",
"url": "https://zapfy.io",
"title": "<string>",
"description": "<string>",
"imgUrl": "<string>",
"delay": 123
}
'import requests
url = "https://api.zapfy.io/v1/messages/send-link"
payload = {
"to": "5511999998888",
"text": "<string>",
"url": "https://zapfy.io",
"title": "<string>",
"description": "<string>",
"imgUrl": "<string>",
"delay": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '5511999998888',
text: '<string>',
url: 'https://zapfy.io',
title: '<string>',
description: '<string>',
imgUrl: '<string>',
delay: 123
})
};
fetch('https://api.zapfy.io/v1/messages/send-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zapfy.io/v1/messages/send-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '5511999998888',
'text' => '<string>',
'url' => 'https://zapfy.io',
'title' => '<string>',
'description' => '<string>',
'imgUrl' => '<string>',
'delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zapfy.io/v1/messages/send-link"
payload := strings.NewReader("{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zapfy.io/v1/messages/send-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zapfy.io/v1/messages/send-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"5511999998888\",\n \"text\": \"<string>\",\n \"url\": \"https://zapfy.io\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"imgUrl\": \"<string>\",\n \"delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"messageId": "3EB0C767D4..."
}
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}{
"error": "Instance not found"
}Authorizations
Instance token (zpfy_inst_...) — sends messages.
Body
application/json
Message recipient: phone in E.164 (e.g. 5511999998888) or a group id.
Example:
"5511999998888"
Text accompanying the link.
Target URL of the link (the preview is generated from it).
Example:
"https://zapfy.io"
Title shown in the link preview.
Description shown in the link preview.
Preview card image.
Optional delay in milliseconds before sending; WhatsApp shows "typing…" during this interval.
Quotes (replies to) a previous message.
Show child attributes
Show child attributes
Response
Message accepted by WhatsApp.
Identifier of the sent message. Store the messageId: together with the same to you sent to, it is what /messages/delete and /messages/edit need.
Show child attributes
Show child attributes
⌘I