Skip to main content
POST
Send media message

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Body

application/json
number
string
required

Recipient MSISDN or JID.

Example:

"5511999999999"

url
string
required

Media URL (JSON mode). In multipart/form-data, send the binary in a file field instead.

Example:

"https://example.com/photo.jpg"

type
string
required

Media kind: image, video, audio, document (also ptv).

Example:

"image"

caption
string

Caption text (image/video/document).

Example:

"Look at this"

filename
string

File name shown for documents.

id
string

Client-supplied message id.

delay
integer

Milliseconds to wait before sending.

mentionedJid
string

JID(s) to mention.

mentionAll
boolean

Mention every participant (groups).

formatJid
boolean

Auto-format number into a JID (default true).

quoted
object

Reply-to reference: { "messageId", "participant" }.

Response

Success — provider-native response body.

Standard Evolution GO send envelope (gin.H). The passthrough layer returns this native body verbatim.

message
string

Fixed status label; always "success" on HTTP 200.

data
object

Media message send result (image shown; the populated key mirrors the request type). Serialized MessageSendStruct (no JSON tags → PascalCase keys Info/Message/MessageContextInfo).