3Play Media: Docs

Delivery Routes

Set up project-wide delivery for your transcripts and audio descriptions

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer Delivery route id
name String Optional name
created_at Datetime When the route was created
updated_at Datetime When the route was last updated
created_by_user_id Integer ID of the user who created this delivery route
asset String Which asset type this delivery route is set up for (either. 'transcript' or 'audio_description')
method String The delivery method (either 'callback', 'ftp', or 'email')
enabled Boolean Whether the delivery route is currently active

Callback delivery routes have the following additional attributes

Name Type Description
url String URL endpoint for callback

Email delivery routes have the following additional attributes

Name Type Description
emails Array<String> Email addresses of recipients

FTP delivery routes have the following additional attributes

Name Type Description
host String FTP host URL
protocol String FTP protocol (ftp:// or ftps://)
path String Path/folder on remote host to which assets will be delivered

Actions

  • Create a new delivery route

    POST https://api.3playmedia.com/v3/transcripts/deliveries

    POST https://api.3playmedia.com/v3/audio_descriptions/deliveries

    Parameter Type Description Required Default
    method String Delivery method: currently only 'callback' and 'email' are supported Yes no default
    name String Name for the delivery route (maximum 255 characters) No no default
    url String (Callback only) URL for callback No no default
    user_id Integer (Email Only) User for email address No no default
  • Update a Delivery Route

    PUT https://api.3playmedia.com/v3/transcripts/deliveries/:id

    PUT https://api.3playmedia.com/v3/audio_descriptions/deliveries/:id

    Parameter Type Description Required Default
    name String Name for the delivery route (maximum 255 characters) No no default
    asset String Which asset type this delivery route is set up for (either 'transcript' or 'audio_description') No no default
    enabled Boolean Whether the delivery route is currently active No true
  • Delete Delivery Route

    DELETE https://api.3playmedia.com/v3/transcripts/deliveries/:id

    DELETE https://api.3playmedia.com/v3/audio_descriptions/deliveries/:id

  • List delivery routes

    GET https://api.3playmedia.com/v3/transcripts/deliveries

    GET https://api.3playmedia.com/v3/audio_descriptions/deliveries

    Parameter Type Description Required Default
    id Integer or Array<Integer> Filter delivery routes by id No no default
    name String Filter deilvery routes by name No no default
    name_cont String Filter deilvery routes by name partial match No no default
    created_before Datetime(rfc3339) Filter delivery routes by date No no default
    created_after Datetime(rfc3339) Filter delivery routes by date No no default
    method String Filter delivery routes by delivery method ('callback', 'email', 'ftp') No no default
    enabled Boolean Filter delivery routes by enabled or not No no default