Encaminhar mensagem

POST

api

chat

forward

:instance

Encaminhar mensagem

curl --request POST \
  --url https://api.example.com/api/chat/forward/:instance \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "messageId": "<string>",
  "to": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({messageId: '<string>', to: '<string>'})
};

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

import requests

url = "https://api.example.com/api/chat/forward/:instance"

payload = {
    "messageId": "<string>",
    "to": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

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

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não Encaminha uma mensagem existente para um destinatário. Para múltiplos destinos, faça múltiplas chamadas. Suporta encaminhamento de: text, image, video, audio, document, sticker, contact, location.
Não suporta: reactions, polls, buttons.

Exemplos

Para contato

Encaminha a mensagem identificada por messageId para um contato individual em to (telefone ou JID @s.whatsapp.net). A mensagem chega ao destinatário com a marca “Encaminhada”.

curl -X POST "https://ryzeapi.cloud/api/chat/forward/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "to": "5511987654321"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/forward/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    to:        "5511987654321"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/forward/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "messageId": "3EB08FCF27E532F1B0F5",
        "to":        "5511987654321"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "to": "5511987654321"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/forward/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Para grupo

Mesma operação, mas com to apontando para um JID de grupo (@g.us). Útil para repassar avisos ou mídias recebidas em outro chat para um grupo inteiro de uma vez.

curl -X POST "https://ryzeapi.cloud/api/chat/forward/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "to": "120363406289005073@g.us"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/forward/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    to:        "120363406289005073@g.us"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/forward/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "messageId": "3EB08FCF27E532F1B0F5",
        "to":        "120363406289005073@g.us"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "to": "120363406289005073@g.us"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/forward/"+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

200 OK

{
  "success": true,
  "message": "Message forwarded successfully",
  "messageId": "3EB08FCF27E532F1B0F7",
  "originalId": "3EB08FCF27E532F1B0F5",
  "destinationJid": "5511987654321@s.whatsapp.net"
}

Campo	Descrição
`messageId`	Novo ID gerado pelo encaminhamento.
`originalId`	ID da mensagem original.
`destinationJid`	JID do destinatário.

Path parameters

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Request body

string

obrigatório

ID da mensagem original (precisa existir no banco da instância).

string

obrigatório

Destino: número (5511...), JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (@g.us) ou newsletter (@newsletter).

Notas

Mídias muito antigas (>14 dias) podem ter os bytes encriptados expirados nos servidores do WhatsApp, nesse caso o encaminhamento falha.
A flag “Encaminhada” aparece naturalmente para o destinatário.
A nova mensagem é ingerida pelo pipeline de eventos e dispara message.exchange (outgoing) no webhook/WebSocket.

Respostas de erro

HTTP	`error.message`	Quando
400	`Invalid request body`	JSON malformado.
400	`messageId is required` ou `to is required`	Campo ausente.
401	`Invalid token`	,
404	`Instance not found` ou `message not found`	,
500	`unsupported message type for forwarding: <tipo>`	Reação, enquete ou interativo.
503	`Instance is not connected to WhatsApp`	Sem sessão ativa.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Encaminhar mensagem

Exemplos

Para contato

Para grupo

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Respostas de erro

​Exemplos

​Para contato

​Para grupo

​Resposta de sucesso

​Path parameters

​Headers

​Request body

​Notas

​Respostas de erro

Exemplos

Para contato

Para grupo

Resposta de sucesso

Path parameters

Headers

Request body

Notas

Respostas de erro