Skip to main content
POST
/
api
/
forwardMessage
cURL
curl --request POST \
  --url https://{host}/api/forwardMessage \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "chatId": "[email protected]",
  "messageId": "[email protected]_AAAAAAAAAAAAAAAAAAAA",
  "session": "my-session"
}
'
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Description

⚠️ This endpoint is not yet implemented. This endpoint will allow forwarding existing messages to other contacts or groups on WhatsApp, maintaining the original format and content of the message.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]",
  "messageId": "3EB0XXXXXX",
  "fromJid": "[email protected]"
}

​
Body Parameters

PropertyTypeRequiredDescription
sessionIdstring✅ YesAuthenticated session ID that will forward the message
jidstring✅ YesRecipient identifier (WhatsApp JID). Format: [email protected] for contacts or [email protected] for groups
messageIdstring✅ YesMessage ID to be forwarded
fromJidstring✅ YesSource chat JID of the message
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Status Codes

  • 200 - Message forwarded successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found
  • 501 - Not implemented

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/forwardMessage \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]",
    "messageId": "3EB0XXXXXX",
    "fromJid": "[email protected]"
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Body

application/json
​
chatId
string
required
​
messageId
string
required
Example:

"[email protected]_AAAAAAAAAAAAAAAAAAAA"

​
session
string
required

Session name (instanceName)

Example:

"my-session"

Response

201 - application/json
​
id
string
required

Message ID

Example:

"[email protected]_AAAAAAAAAAAAAAAAAAAA"

​
timestamp
number
required

Unix timestamp of when the message was created

Example:

1666943582

​
from
string
required

Chat ID to which this message was sent

Example:

"[email protected]"

​
fromMe
boolean
required

Indicates if the message was sent by the current user

​
source
enum<string>
required

The device that sent the message - either API or APP. Available in events (webhooks/websockets) only and only "fromMe: true" messages.

Available options:
api,
app
Example:

"api"

​
to
string
required
  • ID for who this message is for.
  • If the message is sent by the current user, it will be the Chat to which the message is being sent.
  • If the message is sent by another user, it will be the ID for the current user.
Example:

"[email protected]"

​
participant
string
required

For groups - participant who sent the message

​
body
string
required

Message content

​
hasMedia
boolean
required

Indicates if the message has media available for download

​
ack
enum<number>
required

Message acknowledgement (ACK) status

Available options:
-1,
0,
1,
2,
3,
4
​
ackName
string
required

Message acknowledgement status name

​
media
object

Message media object, if any and downloaded

​
author
string

If the message was sent to a group, this field will contain the user who sent the message

​
location
object

Location information contained in the message

​
vCards
string[]

List of vCards contained in the message

​
_data
object

Message in raw WhatsApp format. May change at any time, use with caution!

​
replyTo
object