send a media message (image, video, audio, document)

post

https://waapi.app/api/v1/instances/{id}/client/action/send-media

Send a media file to a chat. Provide either mediaUrl (a publicly accessible URL) or mediaBase64 (base64-encoded file content with mediaName), but not both.

The chatId format varies depending on the chat type:

Individual chat: {phone_number}@c.us (e.g. [email protected])
Group chat: {group_id}@g.us (e.g. [email protected])
Channel/Newsletter: {channel_id}@newsletter (e.g. 123456789@newsletter)

Supported media types:

Images: jpg, jpeg, png, gif
Videos: mp4, 3gp, mov
Audio: mp3, wav, ogg, m4a
Documents: pdf, doc, docx, txt, xlsx, etc

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Instance ID

Body Params

Media can be sent either via URL or Base64. For Base64 media, a filename is required.

chatId

string

required

Chat ID: <number>@c.us or <lid>@lid for a contact (both address the same chat), <id>@g.us for a group.

mediaUrl

string

URL of the media file to send

mediaBase64

string

Base64 encoded media content

mediaCaption

string

Optional caption for the media

mediaName

string

Optional filename for the media (required for Base64)

replyToMessageId

string

Optional message ID to reply to in format:

previewLink

boolean

Defaults to true

Whether to show link previews

asSticker

boolean

Defaults to false

Send image as a sticker

asVoice

boolean

Defaults to false

Send audio as voice message

asDocument

boolean

Defaults to false

Send media as a document

firedandforget

boolean

Defaults to false

Set to true to process the request asynchronously. Returns a reference UUID for polling via GET /instances/{id}/request/{reference}. Alias: faf

Responses

`data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Returns the sent message object.

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

`skipNumberCheck: true`), or when the connected account is under a reach-out restriction and this exact recipient has already been observed being rejected — contacts who replied are unaffected, and retrying counts towards the limit that caused the restriction. The `message` field names which of the two applies.

200Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Returns the sent message object.

429Refused by the instance's send protection. Nothing was sent; retry after the given number of seconds. Integrations that already handle 429 need no change.

`data.status` reports whether the action was carried out; on error `data` carries `message` and `explanation`. Payload: Returns the sent message object.