Send File

POST

/v1/whatsapp/service-account/sendFile

Sends a WhatsApp document/file message (e.g. a PDF) — with an optional filename and caption —from a workspace channel to a destination number.

Auth: OAuth2 client-credentials via /connect/token (policy VoxaAPIScope), same as all service-account endpoints.

fileName is the only field unique to this endpoint vs. Send Image/Send Video — it sets the filename the recipient sees for the document (e.g. document.pdf).

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The message has been accepted and queued for delivery.

Bodyapplication/json

🟢200OK

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠408

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/whatsapp/service-account/sendFile' \
--header 'Authorization: Bearer eyJh......' \
--header 'content-type: application/json' \
--data '{
    "channelId": "3a197.........",
    "fileUrl": "https://example.com/document.pdf",
    "toNumber": "9665xxxxxxxx",
    "fileName": "document.pdf",
    "caption": "Test caption"
}'

Response Example

200 - Official/Dialog360 channel

{
    "contactId": "3a1ca9.........",
    "status": "Sent",
    "message": "Message sent",
    "conversationEventId": "3a1ca9.........",
    "messageId": null
}

Modified at 2026-06-30 17:22:09

Send Video

List Templates (Service Account)