v1

latestSwagger 2.02026-07-1715815.6 KB
Archives

Callback for the OpenTok Archive API.

Gets the updated information for a recording archive.

post/updateArchiveInfo

Request body

idstring

Id of the updated archive

createdAtstring

The timestamp for when the archive started recording, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).

durationstring

The duration of the archive in seconds. For archives that have are being recorded (with the status property set "started"), this value is set to 0.

namestring

The name of the archive you supplied (this is optional)

partnerIdstring

Your OpenTok API key.

reasonstring

For archives with the status "stopped", this can be set to "90 mins exceeded", "failure", "session ended", "user initiated". For archives with the status "failed", this can be set to "system failure".

sessionIdstring

The session ID of the OpenTok session that was archived.

sizestring

The size of the archive file. For archives that have not been generated, this value is set to 0.

statusstring

The status of the archive. Only 'available' and 'uploaded' statuses are actually processed.

urlstring

The download URL of the available archive file. This is only set for an archive with the status set to "available"; for other archives, (including archives with the status "uploaded") this property is set to null. The download URL is obfuscated, and the file is only available from the URL for 10 minutes. To generate a new URL, use the REST API for retrieving archive information or listing archives.

Response

OK