Skip to main content
POST
Send Media (Job-based Processing)

Authorizations

apikey
string
header
required

Your authorization key header

Path Parameters

instance
string
required

Name instance

Body

application/json
number
string
required

Number to receive the message (with country code)

mediatype
string
required

Image, video or document

mimetype
string
required

image/png

caption
string
required

Teste de caption

media
string
required

Url or base64

fileName
string
required

Image.png

delay
integer

Presence time in milliseconds before sending message

Shows a preview of the target website if there's a link within the message

mentionsEveryOne
boolean

Mentioned everyone when the message send

mentioned
enum<string>[]

Numbers to mention

Available options:
{{remoteJID}}
quoted
object

Response

Accepted - Media delivery job queued for background processing

Response for media job submission with real-time tracking capability

jobId
string
required

Unique identifier for the media delivery job. Use this to retrieve real-time status and progress tracking.

Example:

"cuid_abc123xyz"

status
enum<string>
required

Initial job status. Transitions through processing stages: queued → validating → processing → sending → completed or failed.

Available options:
queued
Example:

"queued"

createdAt
string<date-time>
required

ISO 8601 timestamp when the job was created

Example:

"2024-06-07T12:34:56.789Z"