Media

Use these endpoints to upload media files (images, documents, videos) for use in template and session WhatsApp messages, and to retrieve or download previously uploaded media.

Media Upload

POST /oapi/wa/mediaupload

string

required

API key generated for the TUC associated with the sending phone number.

string

application/json

Uploads a local file (multipart) or a remote file URL and returns a media ID/URL you can reference from send-message payloads (e.g. image.id, document.id).

Request parameters

string

required

WhatsApp phone number (with country code) for which media is being uploaded.

file

required

Media file to upload (image, document, video, etc.), sent as multipart form data.

As an alternative to file, send a url form field holding a remote file URL. Send one or the other, not both.

Sample cURL request

curl --location 'https://api.onexaura.com/oapi/wa/mediaupload' \
--header 'accept: application/json' \
--header 'apikey: YOUR_API_KEY' \
--form 'phone_number="919217160065"' \
--form 'file=@"<media file name>"'

Sample JSON payload

{
  "phone_number": "919217160065",
  "file": "binary file data"
}

Sample response payload

string

Media ID assigned to the uploaded file.

string

"success" on successful upload.

integer

HTTP status code of the upload operation.

string

Hosted URL of the uploaded media file.

Response

{
    "id": "27015499406910550",
    "status": "success",
    "http_status": 200,
    "onextel_media_url": "https://warcssm.1xtel.co/media/media/543e3517-9efc-4e72-8c0c-5027530f1cc7/titan20.jpeg"
}

Error codes

Error	Response	Error Description
Invalid Method	405	Method Not Allowed
Missing ApiKey	114 (200)	NO VALID AUTH_KEY FOUND
Invalid ApiKey	200	AUTHENTICATION FAILURE
Missing Content-Type	400	Missing Content-Type / Missing form data
Invalid Content-Type	400	Content-Type must be multipart/form-data or application
Missing phone_number	400	phone_number is mandatory
Neither a file nor URL is provided	400	Either the file or the URL must be provided
Both the file and URL are provided	400	Only one file or URL can be provided
Invalid Json	400	Invalid JSON
Upstream Req Failure	503	Reason of Failure can be multiple
Upstream service unavailable	503	Service unavailable
Unknown Request	500	Internal server error - unexpected arguments

Fetch Media URL

GET /oapi/wa/media

string

required

API key generated for the TUC associated with the sending phone number.

Retrieves the hosted URL for a previously uploaded media item by its media ID.

Query parameters

string

required

Media ID returned from the Media Upload endpoint.

string

required

WhatsApp sender phone number associated with the media.

Sample cURL request

curl --location 'https://api.onexaura.com/oapi/wa/media?mediaId=YOUR_MEDIA_ID&phoneNumber=919999999999' \
--header 'apiKey: YOUR_API_KEY'

Download Media

GET /oapi/wa/download-media

string

required

API key generated for the TUC associated with the sending phone number.

Downloads the media file content for a given hosted media URL.

Query parameters

string

required

Hosted media URL (e.g. the onextel_media_url value returned from Media Upload, or the URL returned from Fetch Media URL).

string

required

WhatsApp sender phone number associated with the media.

Sample cURL request

curl --location 'https://api.onexaura.com/oapi/wa/download-media?mediaUrl=YOUR_MEDIA_URL&phoneNumber=919999999999' \
--header 'apiKey: YOUR_API_KEY'

WhatsApp

RCS

SMS (India)

SMS (International)

OmniChannel

Verify

Media Upload

Request parameters

Sample cURL request

Sample JSON payload

Sample response payload

Error codes

Fetch Media URL

Query parameters

Sample cURL request

Download Media

Query parameters

Sample cURL request

​Media Upload

​Request parameters

​Sample cURL request

​Sample JSON payload

​Sample response payload

​Error codes

​Fetch Media URL

​Query parameters

​Sample cURL request

​Download Media

​Query parameters

​Sample cURL request

Media Upload

Request parameters

Sample cURL request

Sample JSON payload

Sample response payload

Error codes

Fetch Media URL

Query parameters

Sample cURL request

Download Media

Query parameters

Sample cURL request