Enviar link

Send link

curl --request POST \
  --url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "message": "Check out our website: https://www.omni.z-api.io",
  "image": "https://www.omni.z-api.io/logo.png",
  "linkUrl": "https://www.omni.z-api.io",
  "title": "Omni Z-API",
  "linkDescription": "Omnichannel API for Business Communication"
}
'

import requests

url = "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link"

payload = {
    "phone": "5511999999999",
    "message": "Check out our website: https://www.omni.z-api.io",
    "image": "https://www.omni.z-api.io/logo.png",
    "linkUrl": "https://www.omni.z-api.io",
    "title": "Omni Z-API",
    "linkDescription": "Omnichannel API for Business Communication"
}
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({
    phone: '5511999999999',
    message: 'Check out our website: https://www.omni.z-api.io',
    image: 'https://www.omni.z-api.io/logo.png',
    linkUrl: 'https://www.omni.z-api.io',
    title: 'Omni Z-API',
    linkDescription: 'Omnichannel API for Business Communication'
  })
};

fetch('https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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([
    'phone' => '5511999999999',
    'message' => 'Check out our website: https://www.omni.z-api.io',
    'image' => 'https://www.omni.z-api.io/logo.png',
    'linkUrl' => 'https://www.omni.z-api.io',
    'title' => 'Omni Z-API',
    'linkDescription' => 'Omnichannel API for Business Communication'
  ]),
  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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link"

	payload := strings.NewReader("{\n  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\n}"

response = http.request(request)
puts response.read_body

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

{
  "error": 405,
  "message": "Method not allowed"
}

{
  "error": 415,
  "message": "Unsupported media type"
}

POST

send-link

Send link

curl --request POST \
  --url https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "5511999999999",
  "message": "Check out our website: https://www.omni.z-api.io",
  "image": "https://www.omni.z-api.io/logo.png",
  "linkUrl": "https://www.omni.z-api.io",
  "title": "Omni Z-API",
  "linkDescription": "Omnichannel API for Business Communication"
}
'

import requests

url = "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link"

payload = {
    "phone": "5511999999999",
    "message": "Check out our website: https://www.omni.z-api.io",
    "image": "https://www.omni.z-api.io/logo.png",
    "linkUrl": "https://www.omni.z-api.io",
    "title": "Omni Z-API",
    "linkDescription": "Omnichannel API for Business Communication"
}
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({
    phone: '5511999999999',
    message: 'Check out our website: https://www.omni.z-api.io',
    image: 'https://www.omni.z-api.io/logo.png',
    linkUrl: 'https://www.omni.z-api.io',
    title: 'Omni Z-API',
    linkDescription: 'Omnichannel API for Business Communication'
  })
};

fetch('https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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([
    'phone' => '5511999999999',
    'message' => 'Check out our website: https://www.omni.z-api.io',
    'image' => 'https://www.omni.z-api.io/logo.png',
    'linkUrl' => 'https://www.omni.z-api.io',
    'title' => 'Omni Z-API',
    'linkDescription' => 'Omnichannel API for Business Communication'
  ]),
  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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link"

	payload := strings.NewReader("{\n  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\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.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/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  \"phone\": \"5511999999999\",\n  \"message\": \"Check out our website: https://www.omni.z-api.io\",\n  \"image\": \"https://www.omni.z-api.io/logo.png\",\n  \"linkUrl\": \"https://www.omni.z-api.io\",\n  \"title\": \"Omni Z-API\",\n  \"linkDescription\": \"Omnichannel API for Business Communication\"\n}"

response = http.request(request)
puts response.read_body

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

{
  "error": 405,
  "message": "Method not allowed"
}

{
  "error": 415,
  "message": "Unsupported media type"
}

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

linkUrl

string

obrigatório

Link URL

title

string

obrigatório

Link title

linkDescription

string

obrigatório

Link description

linkType

enum<string>

padrão:SMALL

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

string

Same value as messageId (compatibility)

Migração

Mensagens

Conceituação

Autorizações

Corpo

Resposta

​Conceituação

Autorizações

Corpo

Resposta

Conceituação