Page tree
Skip to end of metadata
Go to start of metadata

This guide is valid for Telia Media Services API version 4.0.0 released on 07.05.2018.

API_Telia.php (download)

This is the main class file for API request generation.

Include this file into your script to call the API functions.

config.php (download)

This is the API configuration file.

Modify this file and include it into your script to use your settings. Please enter your client API settings here. You can find your API settings under Admin menu→Client settings→API settings section. Please copy your API secret  and API key into the appropriate places of config.php file.

Send the API requests to https://api.cloudycdn.services/api/v4/

call.php (download)

This is the sample file with sample requests which generate server responses.

Regarding Datetime value type:

All Datetime type values are called and returned as strings in Y-m-d H:i:s format (E.g. 2018-12-10 17:58:23) and are in UTC timezone.

So, for example, if you are in timezone UTC+2 and want to create a recording for 2018-12-10 18:00:00 your time(UTC+2).

You will have to convert it to UTC and send that. Which in the case of UTC+2 will be 2018-12-10 16:00:00.

Request actions

The API function called depends on parameter action and object which are mandatory for every API call. Only "list" action is possible to use GET method otherwise need to use POST method. Other parameters are optional or action specific. 

GET request example:

1) JSON: https://api.cloudycdn.services/api/ md5( CLIENT_API_KEY) / (OBJECT) / (ACTION) ?options[parameter_name_1]=parameter_1_value&.....&options[parameter_name_Z]=parameter_Z_value 

2) RSS: https://api.cloudycdn.services/api/ md5( CLIENT_API_KEY) / media / mrss ?options[parameter_name_1]=parameter_1_value&.....&options[parameter_name_Z]=parameter_Z_value

It enables only when client admin enables it in security settings in client settings.


POST request examples is available in each action description

Please check the list below for available actions.

Possible actions:

ObjectActionFunction
Category


listReturn list of categories

createCreate a category

updateUpdate an existing category

deleteDelete a category
File


listReturn list of files

uploadUpload a new file

updateUpdate an existing file

deleteDelete a file
Live


listReturn list of live channels

connectStart a live channel

disconnectStop a live channel
Media


listReturn list of media assets

uploadUpload a media asset

updateUpdate an existing media asset

deleteDelete a media asset

deleteitemDelete a media file from media asset

validateValidate a media asset

transcodeTranscode a media asset

validatetranscodeValidate and transcode a media asset

resetReset media asset validation
Media manifest


listReturn list of media manifests

addAdd a new manifest to media

updateUpdate an existing media manifest

deleteDelete a media manifest
Preset


listReturn list of presets

createCreate preset

updateUpdate preset

deleteDelete preset

createitemCreate a new bitrate for preset

updateitemUpdate an existing bitrate of preset

deleteitemDelete a bitrate of preset
Record


listReturn list of recordings

createCreate a recording

updateUpdate an existing recording

deleteDelete a recording
Token


generateGenerate content security token
Statistics


listReturn statistics information
  • No labels