POST

https://{server-url}

/
message
/
sendMedia
/
{instance}

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Body

application/json
number
string
required

Number to receive the message (with country code)

mediatype
enum<string>
required

Media type

Available options:
image,
video,
document,
audio
mimetype
string

Media mimetype

caption
string

Caption to send with media (except with media type audio)

media
string
required

Media URL or file in base64

fileName
string

Name of the file (for media type document only)

delay
integer

Presence time in milliseconds before sending message

quoted
object
mentionsEveryOne
boolean

Mention everyone on a group message

mentioned
string[]

Response

201 - application/json
key
object

The key of the message, which identifies the message in the chat.

message
object

The message content, which may include various types of messages like text, images, etc.

messageTimestamp
string

The timestamp of the message, represented as a string.

status
string

The status of the message, such as sent, received, or pending.