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

> Envia mensagem de texto com suporte a delay, link preview, reply, reply privado e menções

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

## Descrição

Envia uma mensagem de texto a um contato 1-a-1, grupo (`@g.us`) ou canal (`@newsletter`). Suporta `replyTo` (citação por ID), `replyPrivate` (responder no privado a partir de uma mensagem de grupo), `mention` / `mentionAll` (apenas em grupos), `linkPreview` e `delay` (em segundos) para simular digitação real. É o endpoint mais usado e serve como "Hello World" para validar que a instância está conectada.

## Exemplos

### Mínimo

Envia uma mensagem de texto com o payload mínimo (`number` + `message`). Sem `delay`, sem preview, sem citação, útil como "Hello World" para validar que a instância está conectada.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "5511999999999",
      "message": "Olá! Este é um teste do RyzeAPI."
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "5511999999999",
      message: "Olá! Este é um teste do RyzeAPI."
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "5511999999999",
          "message": "Olá! Este é um teste do RyzeAPI."
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":  "5511999999999",
          "message": "Olá! Este é um teste do RyzeAPI."
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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>

### Com delay e link preview

Envia indicador de "digitando..." por 3 segundos e depois envia a mensagem com prévia da URL detectada.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":      "5511999999999",
      "message":     "Confere aí: https://ryzeapi.cloud",
      "delay":       3,
      "linkPreview": true
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:      "5511999999999",
      message:     "Confere aí: https://ryzeapi.cloud",
      delay:       3,
      linkPreview: true
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":      "5511999999999",
          "message":     "Confere aí: https://ryzeapi.cloud",
          "delay":       3,
          "linkPreview": True
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":      "5511999999999",
          "message":     "Confere aí: https://ryzeapi.cloud",
          "delay":       3,
          "linkPreview": true
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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

Cita uma mensagem existente (`replyTo` recebe o `messageId` da mensagem original). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco (qualquer mensagem trafegada via webhook/envio é salva automaticamente).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "5511999999999",
      "message": "Sim, confirmado!",
      "replyTo": "3EB08FCF27E532F1B0F5"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "5511999999999",
      message: "Sim, confirmado!",
      replyTo: "3EB08FCF27E532F1B0F5"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "5511999999999",
          "message": "Sim, confirmado!",
          "replyTo": "3EB08FCF27E532F1B0F5"
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":  "5511999999999",
          "message": "Sim, confirmado!",
          "replyTo": "3EB08FCF27E532F1B0F5"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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 no privado (grupo)

Quando alguém manda uma mensagem em um **grupo** e você quer responder **no privado** dessa pessoa (sem retornar a resposta para o grupo), use `replyPrivate: true`. O `number` deve apontar para o JID do grupo onde a mensagem original foi enviada, o servidor extrai o autor original e redireciona a resposta para o privado dele, mantendo a citação.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":       "120363406289005073@g.us",
      "message":      "Te respondendo no privado para não poluir o grupo.",
      "replyTo":      "3EB08FCF27E532F1B0F5",
      "replyPrivate": true
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:       "120363406289005073@g.us",
      message:      "Te respondendo no privado para não poluir o grupo.",
      replyTo:      "3EB08FCF27E532F1B0F5",
      replyPrivate: true
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":       "120363406289005073@g.us",
          "message":      "Te respondendo no privado para não poluir o grupo.",
          "replyTo":      "3EB08FCF27E532F1B0F5",
          "replyPrivate": True
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":       "120363406289005073@g.us",
          "message":      "Te respondendo no privado para não poluir o grupo.",
          "replyTo":      "3EB08FCF27E532F1B0F5",
          "replyPrivate": true
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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>

### Com menção a membro(s) (grupo)

Adiciona menção visível com `@5511...` no corpo da mensagem e lista os números no array `mention`. O texto e o array precisam estar **consistentes**, o WhatsApp só transforma em link clicável o que estiver no `mention`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "120363406289005073@g.us",
      "message": "Atenção @5511888888888 e @5511777777777, reunião às 14h.",
      "mention": ["5511888888888", "5511777777777"]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "120363406289005073@g.us",
      message: "Atenção @5511888888888 e @5511777777777, reunião às 14h.",
      mention: ["5511888888888", "5511777777777"]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "120363406289005073@g.us",
          "message": "Atenção @5511888888888 e @5511777777777, reunião às 14h.",
          "mention": ["5511888888888", "5511777777777"]
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":  "120363406289005073@g.us",
          "message": "Atenção @5511888888888 e @5511777777777, reunião às 14h.",
          "mention": ["5511888888888", "5511777777777"]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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>

### Menção oculta (grupo)

Faz **ping em todos os membros do grupo** sem precisar listar @s no texto, usando `mentionAll: true`. O texto exibido fica limpo, mas os participantes recebem a notificação de menção. Útil para anúncios silenciosos. Para mencionar pessoas específicas de forma oculta, basta usar `mention: ["..."]` **sem** colocar `@número` no texto, eles também recebem a notificação sem aparecer marcados.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":     "120363406289005073@g.us",
      "message":    "Aviso geral: reunião confirmada para amanhã às 14h.",
      "mentionAll": true
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/text/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:     "120363406289005073@g.us",
      message:    "Aviso geral: reunião confirmada para amanhã às 14h.",
      mentionAll: true
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/text/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":     "120363406289005073@g.us",
          "message":    "Aviso geral: reunião confirmada para amanhã às 14h.",
          "mentionAll": True
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "number":     "120363406289005073@g.us",
          "message":    "Aviso geral: reunião confirmada para amanhã às 14h.",
          "mentionAll": true
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/text/"+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

A resposta inclui o `messageId` (use-o em `replyTo` para citar essa mensagem em envios futuros), o `direction: "outgoing"` e a marcação de chat/sender. Os campos `mentions` e `replyTo` só aparecem quando aplicáveis, e `chat.groupName` é incluído em mensagens de grupo.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Message sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1B0F5",
    "direction":   "outgoing",
    "messageType": "text",
    "content":     "Olá! Este é um teste do RyzeAPI.",
    "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"
    },
    "mentions": {
      "mentionedUsers": ["5511888888888"],
      "mentionAll":     false,
      "totalMentions":  1
    },
    "replyTo": {
      "messageId": "3EB08FCF27E532F1A1A1",
      "content":   "Tudo certo para amanhã?"
    }
  }
}
```

## 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="message" type="string" required>
  Corpo do texto. Não pode estar vazio.
</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="linkPreview" type="boolean" default="false">
  Quando `true`, o servidor extrai a primeira URL do `message`, busca os metadados Open Graph (título, descrição, thumbnail) e envia a mensagem como `ExtendedTextMessage` com o card de preview embutido. Quando `false` ou omitido, a URL aparece como texto simples.
</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. Erros possíveis: `reply_message_not_found`, `reply_message_instance_mismatch`.
</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). Útil para responder dúvidas individualmente sem poluir o grupo. Ignorado se a mensagem original não for de grupo.
</ParamField>

<ParamField body="mention" type="string[]">
  Lista de números (ou JIDs) a mencionar. **Apenas em grupos** (`@g.us`). Limite de **10** menções por mensagem, números excedentes são ignorados com warning. Para que apareçam como link clicável, inclua `@5511...` no `message`. Sem isso, viram menções ocultas (apenas notificam).
</ParamField>

<ParamField body="mentionAll" type="boolean" default="false">
  Quando `true`, menciona **todos os membros do grupo** (exceto a própria instância). Equivale ao `@todos`/`@everyone`. O servidor consulta a lista de participantes e injeta cada JID no `MentionedJID` do contexto, sem alterar o texto exibido. **Apenas em grupos.**
</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** (diferente de muitas APIs que usam ms). Valor `3` = 3 segundos de "digitando".
  * Em grupos, o texto com `@5511...` por si só **não vira clickable**, é o array `mention` que o WhatsApp processa. Mantenha os dois consistentes.
  * `mention` **e** `mentionAll` são exclusivos a grupos. Se enviados para DM/canal, retorna `400 Mentions are only supported in group chats`.
  * Para números BR (começando com `55`), o serviço tenta automaticamente variações com e sem o 9º dígito, evitando o histórico de inconsistências em DDDs antigos.
  * `linkPreview` requer que o servidor consiga buscar os metadados Open Graph da URL, sites com bloqueio de bots podem cair no fallback de texto simples sem erro visível.
  * Mensagens enviadas via `replyPrivate: true` aparecem no privado do destinatário com o card da mensagem citada do grupo, ele consegue ver de qual conversa veio.
</Note>

## Erros

| HTTP | Status interno                    | Mensagem                                            |
| ---- | --------------------------------- | --------------------------------------------------- |
| 400  | ,                                 | `Instance name is required`                         |
| 400  | ,                                 | `Invalid request body: <detalhe>`                   |
| 400  | ,                                 | `Number is required`                                |
| 400  | ,                                 | `Message is required`                               |
| 400  | `invalid_number`                  | `Invalid phone number format: <detalhe>`            |
| 400  | `mentions_not_supported`          | `Mentions are only supported in group chats`        |
| 400  | `reply_message_not_found`         | `Original message not found (ID: ...)`              |
| 400  | `reply_message_instance_mismatch` | `Original message does not belong to this instance` |
| 400  | `private_reply_failed`            | (motivo do erro de redirecionamento privado)        |
| 404  | ,                                 | `Instance not found`                                |
| 500  | `send_failed`                     | `Failed to send message: <reason>`                  |
| 503  | `disconnected`                    | `Instance is not connected to WhatsApp`             |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "Message is required" }
}
```