3Play Media: Docs

Orders

Bulk order actions for your 3Play Media files

Actions

  • Place a bulk order

    POST https://api.3playmedia.com/v3/orders/bulk/

    Parameter Type Description Required Default
    files String JSON-encoded array of file parameters Yes no default
    services String JSON-encoded array of service parameters Yes no default
    callback String Callback URL for status updates No no default
    batch_id Integer The ID of the 3Play Batch for all files in this order. This can be overridden for individual files. No no default
    Note that the callback URL applies to each ordered service. File parameters are similar to the media file API action, and are as follows for each element in the JSON-encoded array:
    Parameter Type Description Required Default
    source_url String The URL to a publicly accessible video or audio file No no default
    name String The name of the file (maximum 300 characters) No no default
    language_id Integer or Array<Integer> The file's language(s) Yes no default
    batch_id Integer The ID of the 3Play Batch for this file. This overrides the top-level 'batch_id' parameter. No no default
    attribute1 String Arbitrary data attribute No no default
    attribute2 String Arbitrary data attribute No no default
    attribute3 String Arbitrary data attribute No no default
    reference_id String An arbitrary reference id that can be used to identify the file on an external system such as a CMS or video platform. No no default
    Service parameters currently only support transcription, and are as follows for each element in the JSON-encoded array:
    Parameter Type Description Required Default
    type String The type of 3Play service you wish to order. Currently, only 'transcription' is supported. Yes no default
    turnaround_level_id Integer The id of the 3Play turnaround level you wish to order No 1
    This route returns the following attributes for each file created. While files ids can immediately be queried, please note that services are processed asynchronously and may not be immediately available.
    Name Type Description
    id Integer 3Play Media ID
    name String Name of file
    language_id Integer Primary language for file
    language_ids Array<Iteger> All langauges associated with this file
    batch_id Integer The 3Play batch this file belongs to
    reference_id String An arbitrary reference ID that can be used to identify the video in an external account, such as a CMS or other video platform. This is also referred to as the file's 'video_id'