Enviar Localização

POST

api

message

location

:instance

Enviar Localização

curl --request POST \
  --url https://api.example.com/api/message/location/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "latitude": {},
  "longitude": {},
  "name": "<string>",
  "address": "<string>",
  "delay": 123,
  "replyTo": "<string>",
  "replyPrivate": true,
  "source": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    latitude: {},
    longitude: {},
    name: '<string>',
    address: '<string>',
    delay: 123,
    replyTo: '<string>',
    replyPrivate: true,
    source: '<string>'
  })
};

fetch('https://api.example.com/api/message/location/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/message/location/:instance"

payload = {
    "number": "<string>",
    "latitude": {},
    "longitude": {},
    "name": "<string>",
    "address": "<string>",
    "delay": 123,
    "replyTo": "<string>",
    "replyPrivate": True,
    "source": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não

Descrição

Envia uma localização geográfica como mensagem rica (LocationMessage), com latitude, longitude, name (rótulo principal) e address (linha secundária). O destinatário visualiza um card com prévia do mapa e botões de “Abrir no mapa”. Suporta replyTo, replyPrivate, delay (em segundos) e source. Não suporta menções.

Exemplos

Localização simples

Envia um card de localização com as coordenadas da Avenida Paulista (-23.5614, -46.6558), nome do lugar e endereço completo. O destinatário vê a prévia do mapa e pode abrir no app de navegação.

curl -X POST "https://ryzeapi.cloud/api/message/location/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":    "5511999999999",
    "latitude":  -23.5614,
    "longitude": -46.6558,
    "name":      "Avenida Paulista",
    "address":   "Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
  }'

await fetch(`https://ryzeapi.cloud/api/message/location/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:    "5511999999999",
    latitude:  -23.5614,
    longitude: -46.6558,
    name:      "Avenida Paulista",
    address:   "Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/location/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":    "5511999999999",
        "latitude":  -23.5614,
        "longitude": -46.6558,
        "name":      "Avenida Paulista",
        "address":   "Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":    "5511999999999",
        "latitude":  -23.5614,
        "longitude": -46.6558,
        "name":      "Avenida Paulista",
        "address":   "Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/location/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Como resposta a uma mensagem

Envia o card de localização citando uma mensagem anterior via replyTo. Útil para responder a uma pergunta do tipo “onde a gente se encontra?” mantendo a citação da mensagem original.

curl -X POST "https://ryzeapi.cloud/api/message/location/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":    "5511999999999",
    "latitude":  -23.5614,
    "longitude": -46.6558,
    "name":      "Ponto de encontro",
    "address":   "Av. Paulista, 1578",
    "replyTo":   "3EB08FCF27E532F1B0F5"
  }'

await fetch(`https://ryzeapi.cloud/api/message/location/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:    "5511999999999",
    latitude:  -23.5614,
    longitude: -46.6558,
    name:      "Ponto de encontro",
    address:   "Av. Paulista, 1578",
    replyTo:   "3EB08FCF27E532F1B0F5"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/message/location/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":    "5511999999999",
        "latitude":  -23.5614,
        "longitude": -46.6558,
        "name":      "Ponto de encontro",
        "address":   "Av. Paulista, 1578",
        "replyTo":   "3EB08FCF27E532F1B0F5"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":    "5511999999999",
        "latitude":  -23.5614,
        "longitude": -46.6558,
        "name":      "Ponto de encontro",
        "address":   "Av. Paulista, 1578",
        "replyTo":   "3EB08FCF27E532F1B0F5"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/location/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

O content traz uma representação textual da localização (📍 nome\nendereço\nLat: ..., Long: ...) salva no histórico, e o messageType é fixo em location.

200 OK

{
  "success": true,
  "message": "Location sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1B0F5",
    "direction":   "sent",
    "messageType": "location",
    "content":     "📍 Avenida Paulista\nAv. Paulista, 1578 - Bela Vista, São Paulo - SP\nLat: -23.561414, Long: -46.655881",
    "source":      "api",
    "timestamp":   "2026-04-30T14:30:00Z",
    "chat": {
      "jid":     "5511999999999@s.whatsapp.net",
      "isGroup": false
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}

Parâmetros de rota

string

obrigatório

Nome da instância (ex.: $Instance_Name).

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

Destino: telefone (5511999999999) ou JID (@s.whatsapp.net, @lid, @g.us, @newsletter).

float64

obrigatório

Latitude geográfica em graus decimais (ex.: -23.5614). Precisão recomendada de 4 a 6 casas decimais.

float64

obrigatório

Longitude geográfica em graus decimais (ex.: -46.6558).

string

obrigatório

Rótulo principal exibido no card de localização (linha em destaque). Costuma ser o nome do lugar/estabelecimento.

string

obrigatório

Endereço/descrição secundária exibida abaixo do name no card.

int

padrão:"0"

Tempo em segundos para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de “digitando…” ao destinatário e dispara o “paused” antes do envio real.

string

ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.

boolean

padrão:"false"

Quando true e replyTo aponta para uma mensagem originária de um grupo, a resposta é redirecionada para o privado do autor original (mantendo a citação). Ignorado se a mensagem original não for de grupo.

string

padrão:"api"

Identificador de origem para rastreabilidade (ex.: crm, bot-suporte, n8n). Salvo no registro da mensagem no banco e propagado para webhooks. Quando omitido, assume "api".

Notas

delay é em segundos, não milissegundos.
A validação atual rejeita o envio quando ambos latitude e longitude são exatamente 0, o ponto (0, 0) no Atlântico raramente é uma intenção legítima e geralmente indica payload com campo faltando.
Mensagens de localização não suportam mention nem mentionAll.
Localização “ao vivo” (live location) não é suportada por este endpoint, apenas localização estática.
Para números BR (começando com 55), o serviço tenta automaticamente variações com e sem o 9º dígito.

Erros

HTTP	Status interno	Mensagem
400	,	`Instance name is required`
400	,	`Invalid request body: <detalhe>`
400	,	`Number is required`
400	,	`Latitude and longitude are required`
400	,	`Name is required`
400	,	`Address is required`
400	`invalid_number`	`Invalid phone number format: <detalhe>`
500	`send_failed`	`Failed to send message: <reason>`
404	,	`Instance not found`
503	`disconnected`	`Instance is not connected to WhatsApp`

Envelope de erro:

{
  "success": false,
  "error": { "message": "Latitude and longitude are required" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Enviar Localização

Descrição

Exemplos

Localização simples

Como resposta a uma mensagem

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Localização simples

​Como resposta a uma mensagem

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Localização simples

Como resposta a uma mensagem

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros