Enviar localização
curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"identifier": "5544936181064",
"name": "Nome do Destinatário",
"subject": "Título",
"picture": ""
},
"sender": {
"identifier": "5544936181064",
"name": "Nome do Remetente",
"picture": ""
},
"content": {
"type": "LOCATION",
"attachments": [
{
"name": "Google Brasil",
"address": "Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133",
"latitude": "-23.0696347",
"longitude": "-50.4357913"
}
]
}
}
'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}/messages"
payload = {
"recipient": {
"identifier": "5544936181064",
"name": "Nome do Destinatário",
"subject": "Título",
"picture": ""
},
"sender": {
"identifier": "5544936181064",
"name": "Nome do Remetente",
"picture": ""
},
"content": {
"type": "LOCATION",
"attachments": [
{
"name": "Google Brasil",
"address": "Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133",
"latitude": "-23.0696347",
"longitude": "-50.4357913"
}
]
}
}
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({
recipient: {
identifier: '5544936181064',
name: 'Nome do Destinatário',
subject: 'Título',
picture: ''
},
sender: {identifier: '5544936181064', name: 'Nome do Remetente', picture: ''},
content: {
type: 'LOCATION',
attachments: [
{
name: 'Google Brasil',
address: 'Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133',
latitude: '-23.0696347',
longitude: '-50.4357913'
}
]
}
})
};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}/messages', 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/v1/channels/{channelId}/messages",
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([
'recipient' => [
'identifier' => '5544936181064',
'name' => 'Nome do Destinatário',
'subject' => 'Título',
'picture' => ''
],
'sender' => [
'identifier' => '5544936181064',
'name' => 'Nome do Remetente',
'picture' => ''
],
'content' => [
'type' => 'LOCATION',
'attachments' => [
[
'name' => 'Google Brasil',
'address' => 'Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133',
'latitude' => '-23.0696347',
'longitude' => '-50.4357913'
]
]
]
]),
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/v1/channels/{channelId}/messages"
payload := strings.NewReader("{\n \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\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/v1/channels/{channelId}/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/messages")
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 \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 422,
"message": "Conversation window is closed"
}Mensagens
Enviar localização
Envie mensagens de localização
POST
/
v1
/
channels
/
{channelId}
/
messages
Enviar localização
curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": {
"identifier": "5544936181064",
"name": "Nome do Destinatário",
"subject": "Título",
"picture": ""
},
"sender": {
"identifier": "5544936181064",
"name": "Nome do Remetente",
"picture": ""
},
"content": {
"type": "LOCATION",
"attachments": [
{
"name": "Google Brasil",
"address": "Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133",
"latitude": "-23.0696347",
"longitude": "-50.4357913"
}
]
}
}
'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}/messages"
payload = {
"recipient": {
"identifier": "5544936181064",
"name": "Nome do Destinatário",
"subject": "Título",
"picture": ""
},
"sender": {
"identifier": "5544936181064",
"name": "Nome do Remetente",
"picture": ""
},
"content": {
"type": "LOCATION",
"attachments": [
{
"name": "Google Brasil",
"address": "Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133",
"latitude": "-23.0696347",
"longitude": "-50.4357913"
}
]
}
}
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({
recipient: {
identifier: '5544936181064',
name: 'Nome do Destinatário',
subject: 'Título',
picture: ''
},
sender: {identifier: '5544936181064', name: 'Nome do Remetente', picture: ''},
content: {
type: 'LOCATION',
attachments: [
{
name: 'Google Brasil',
address: 'Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133',
latitude: '-23.0696347',
longitude: '-50.4357913'
}
]
}
})
};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}/messages', 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/v1/channels/{channelId}/messages",
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([
'recipient' => [
'identifier' => '5544936181064',
'name' => 'Nome do Destinatário',
'subject' => 'Título',
'picture' => ''
],
'sender' => [
'identifier' => '5544936181064',
'name' => 'Nome do Remetente',
'picture' => ''
],
'content' => [
'type' => 'LOCATION',
'attachments' => [
[
'name' => 'Google Brasil',
'address' => 'Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133',
'latitude' => '-23.0696347',
'longitude' => '-50.4357913'
]
]
]
]),
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/v1/channels/{channelId}/messages"
payload := strings.NewReader("{\n \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\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/v1/channels/{channelId}/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/messages")
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 \"recipient\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Destinatário\",\n \"subject\": \"Título\",\n \"picture\": \"\"\n },\n \"sender\": {\n \"identifier\": \"5544936181064\",\n \"name\": \"Nome do Remetente\",\n \"picture\": \"\"\n },\n \"content\": {\n \"type\": \"LOCATION\",\n \"attachments\": [\n {\n \"name\": \"Google Brasil\",\n \"address\": \"Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP, 04538-133\",\n \"latitude\": \"-23.0696347\",\n \"longitude\": \"-50.4357913\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"messageId": "wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 422,
"message": "Conversation window is closed"
}Conceituação
Envia uma mensagem de localização para um contato. O campocontent.type deve ser LOCATION e as coordenadas são informadas no array attachments com latitude e longitude.
Os campos name e address são opcionais e permitem exibir o nome e o endereço do local diretamente na mensagem.
A API não valida os campos
latitude e longitude. Requisições sem esses valores serão aceitas, mas a mensagem não exibirá a localização corretamente no WhatsApp. Sempre informe ambos os campos.Detalhes da regra do WhatsApp Oficial em janela de conversa. Veja a matriz de capacidades para todos os canais.
Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do canal
Exemplo:
"SEU_CHANNEL_ID"
Corpo
application/json
Resposta
Mensagem enviada com sucesso
ID da mensagem enviada