> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Localização

> Envia coordenadas geográficas com nome e endereço

**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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
    }'
  ```

  ```javascript JavaScript theme={null}
  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"
    })
  });
  ```

  ```python Python theme={null}
  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"
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
    }'
  ```

  ```javascript JavaScript theme={null}
  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"
    })
  });
  ```

  ```python Python theme={null}
  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"
      }
  )
  ```

  ```go Go theme={null}
  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)
  }
  ```
</CodeGroup>

## 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`.

```json 200 OK theme={null}
{
  "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

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID (`@s.whatsapp.net`, `@lid`, `@g.us`, `@newsletter`).
</ParamField>

<ParamField body="latitude" type="float64" required>
  Latitude geográfica em graus decimais (ex.: `-23.5614`). Precisão recomendada de 4 a 6 casas decimais.
</ParamField>

<ParamField body="longitude" type="float64" required>
  Longitude geográfica em graus decimais (ex.: `-46.6558`).
</ParamField>

<ParamField body="name" type="string" required>
  Rótulo principal exibido no card de localização (linha em destaque). Costuma ser o nome do lugar/estabelecimento.
</ParamField>

<ParamField body="address" type="string" required>
  Endereço/descrição secundária exibida abaixo do `name` no card.
</ParamField>

<ParamField body="delay" type="int" default="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.
</ParamField>

<ParamField body="replyTo" type="string">
  ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
</ParamField>

<ParamField body="replyPrivate" type="boolean" default="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.
</ParamField>

<ParamField body="source" type="string" default="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"`.
</ParamField>

## Notas

<Note>
  * **`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.
</Note>

## 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:

```json theme={null}
{
  "success": false,
  "error": { "message": "Latitude and longitude are required" }
}
```