Recordings

Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.

Fetch all recordings

This operation shows limited details for all of your recordings. For detailed information, fetch a single recording.

Request

query Parameters

filter	string Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index. For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API. Example: filter[0][field]=state&filter[0][eq]=stopped
page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (recordings)

Array

created_at	string <date-time> The date and time that the recording was created.
id	string The unique alphanumeric string that identifies the recording.
asset_id	string Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management.
file_name	string The file name of the recording. Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.
real_time_stream_id	string Only applies to Real-Time Streaming at Scale. The unique alphanumeric string that identifies the real-time stream that was recorded.
reason	string The reason that a recording has the state failed.
state	string The state of the recording. Enum: "uploading" "converting" "removing" "completed" "failed"
transcoder_id	string The unique alphanumeric string that identifies the transcoder that was recorded.
updated_at	string <date-time> The date and time that the recording was updated.

401

Unauthorized

get/recordings

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/recordings"

Response samples

application/json

{"recordings": [{"id": "4Jjzstdt",
"transcoder_id": "bjaplmrw",
"state": "converting",
"reason": "",
"file_name": "31a4f9f4.stream.0.mp4",
"created_at": "2023-01-29T17:16:21.993Z",
"updated_at": "2023-01-31T10:37:57.993Z"
},
{"id": "fFWxVsyj",
"state": "completed",
"reason": "",
"file_name": "my_rts_recording.mp4",
"asset_id": "thfsm6c2",
"real_time_asset_id": "xbzk91ts",
"created_at": "2023-01-28T17:16:21.993Z",
"updated_at": "2023-01-30T21:34:45.993Z"
}
]
}

Fetch a recording

This operation shows the details of a specific recording.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the recording.

Responses

200

Success

Response Schema: application/json

required

object (recording)

asset_id	string Only applies to recordings created for Asset Management. The id for the asset associated with your recording. You can manage your asset in Asset Management.
created_at	string <date-time> The date and time that the recording was created.
download_url	string The URL that can be used to download the recording.
duration	integer <int64> The length of the recording, in hours, minutes, and seconds.
file_name	string The file name of the recording. Note: To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names.
file_size	integer <int64> The file size of the recording.
id	string The unique alphanumeric string that identifies the recording.
real_time_stream_id	string Only applies to Real-Time Streaming at Scale. The unique alphanumeric string that identifies the real-time stream that was recorded.
reason	string The reason that a recording has the state failed.
starts_at	string The date and time that the recording started.
state	string The state of the recording. Enum: "uploading" "converting" "removing" "completed" "failed"
transcoder_id	string The unique alphanumeric string that identifies the transcoder that was recorded.
transcoder_name	string The descriptive name of the transcoder that was recorded.
transcoding_uptime_id	string <date-time> The unique identifier associated with the transcoding uptime for this recording.
updated_at	string <date-time> The date and time that the recording was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/recordings/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/recordings/2adffc17"

Response samples

application/json

{"recording": {"created_at": "2020-01-29T17:16:21.993Z",
"download_url": "https://s3.amazonaws.com/prod-wse-recordings/transcoder_035163/64886_00a613bf@367500.stream.0.mp4",
"duration": 362905,
"file_name": "00a613bf@367500.stream.0.mp4",
"file_size": 53113429,
"id": "4Jjzstdt",
"reason": "",
"starts_at": "2020-02-01T00:00:00.000Z",
"transcoding_uptime_id": "vxyz9876",
"state": "completed",
"transcoder_id": "bjQplmRw",
"transcoder_name": "My Camera",
"updated_at": "2020-01-30T17:22:20.993Z"
}
}

Delete a recording

This operation deletes a recording.

Note: You can't remove recordings that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the recording.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/recordings/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.11/recordings/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Fetch the state of a recording

This operation shows the current state of a recording.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the recording.

Responses

200

Success

Response Schema: application/json

required

object (recording)

state

string

The state of the recording.

Enum: "uploading" "converting" "removing" "completed" "failed"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/recordings/{id}/state

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/recordings/2adffc17/state"

Response samples

application/json

{"recording": {"state": "completed"
}
}