Media

Upload and retrieve binary media files (images, documents, audio, video) for use in rich message content types such as RCS or WhatsApp.

Upload a media file

post

Uploads a binary media file (image, document, audio, or video) and returns a mediaId that can be referenced in rich message content fields such as ImageContent.mediaId, DocumentContent.mediaId, etc.

Authorizations

BasicAuth

AuthorizationstringRequired

HTTP Basic Authentication. Encode username:password in Base64 and pass as: Authorization: Basic <base64_encoded_credentials>

Use your eCall account credentials or a dedicated API sub-user created in the eCall portal (Interfaces → Overview).

Body

multipart/form-data

filestring · binaryOptional

The file to upload.

Responses

201

File uploaded successfully.

application/json

Result of a successful media upload.

mediaIdstring · nullableOptional

Unique identifier of the uploaded media file. Use this in message content.

Example: a3f1c890-bb22-4c1d-a7e3-d3f1a2b4c567

400

The request is invalid. This may be caused by a missing required parameter, an invalid value, or a constraint violation. Check the errorCode and errorDetails in the response body for specifics.

application/json

401

The Authorization header is missing or the credentials are invalid. Verify your username, password, and Base64 encoding.

application/json

500

An unexpected error occurred on the eCall server. Retry after a short delay. If the problem persists, contact eCall support and include the x-f24-request-id header value from the response.

application/json

post/api/v2/media

HTTPcURLJavaScriptPython

POST /api/v2/media HTTP/1.1
Host: rest.ecall.ch
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "mediaId": "a3f1c890-bb22-4c1d-a7e3-d3f1a2b4c567"
}

Retrieve a media file

get

Downloads a previously uploaded media file by its mediaId.

Authorizations

BasicAuth

AuthorizationstringRequired

HTTP Basic Authentication. Encode username:password in Base64 and pass as: Authorization: Basic <base64_encoded_credentials>

Use your eCall account credentials or a dedicated API sub-user created in the eCall portal (Interfaces → Overview).

Path parameters

mediaIdstring · uuidRequired

Unique identifier of the media file, as returned by the upload endpoint.

Responses

200

Media file returned as binary.

application/octet-stream

string · binaryOptional

400

The request is invalid. This may be caused by a missing required parameter, an invalid value, or a constraint violation. Check the errorCode and errorDetails in the response body for specifics.

application/json

401

The Authorization header is missing or the credentials are invalid. Verify your username, password, and Base64 encoding.

application/json

404

The requested resource (message ID, media ID, etc.) was not found.

application/json

500

An unexpected error occurred on the eCall server. Retry after a short delay. If the problem persists, contact eCall support and include the x-f24-request-id header value from the response.

application/json

get/api/v2/media/{mediaId}

HTTPcURLJavaScriptPython

GET /api/v2/media/{mediaId} HTTP/1.1
Host: rest.ecall.ch
Authorization: Basic username:password
Accept: */*

binary