Skip to main content
POST
Send image message
Sends an image to the recipient. The image field accepts a public URL or the content in base64. Use caption to add a caption.
Supported formats include JPEG and PNG. For large files, prefer sending by URL — it is faster and avoids heavy payloads.

Authorizations

Authorization
string
header
required

API Key for authentication. Format: <API_KEY>

Body

sessionId
string
required
Minimum string length: 1
to
string
required
Minimum string length: 1
image
string
required
Minimum string length: 1
caption
string
contextInfo
object

ContextInfo proto JSON. Supports mentions, replies (quotedMessage), forwarding, ads, and other metadata.

Example:
mentionAll
boolean
async
sequential

With async: true, sends to THIS recipient go out one at a time, in the order the API received them. Sends to other recipients still run in parallel. This order is the order of arrival at the backend: requests fired in parallel by the client have no order to preserve — send them serially. There is a limit on accumulated pending sends per recipient; when it is exceeded the API responds 429 and the client should retry later. Ignored without async: true and in Official API sessions (cloud_api), where sending is always synchronous.

Response

200

Successful response