Pular para o conteúdo principal
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>"
}
'

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.

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"
  }'

​
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"
  }'

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Message forwarded successfully",
  "messageId": "3EB08FCF27E532F1B0F7",
  "originalId": "3EB08FCF27E532F1B0F5",
  "destinationJid": "5511987654321@s.whatsapp.net"
}
CampoDescrição
messageIdNovo ID gerado pelo encaminhamento.
originalIdID da mensagem original.
destinationJidJID do destinatário.

​
Path parameters

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Request body

​
messageId
string
obrigatório
ID da mensagem original (precisa existir no banco da instância).
​
to
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

HTTPerror.messageQuando
400Invalid request bodyJSON malformado.
400messageId is required ou to is requiredCampo ausente.
401Invalid token—
404Instance not found ou message not found—
500unsupported message type for forwarding: <tipo>Reação, enquete ou interativo.
503Instance is not connected to WhatsAppSem sessão ativa.