Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

List Recordings

Lists recordings. You can specify a date range, a parent meeting ID and the maximum number of recordings to return.

Only recordings of meetings hosted by or shared with the authenticated user will be listed.

If meetingId is specified, only recordings associated with the specified meeting will be listed.

The list returned is sorted in descending order by the date and time that the recordings were created.

Long result sets are split into pages.

GET/v1/recordings
Query Parameters
max
number

Maximum number of recordings to return in a single page. max must be equal to or greater than 1 and equal to or less than 100.

Default: 10
from
string

Starting date and time (inclusive) for recordings to return, in any ISO 8601 compliant format. from cannot be after current date and time or after to.

Default: If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before current date and time.
to
string

Ending date and time (exclusive) for List recordings to return, in any ISO 8601 compliant format. to cannot be after current date and time or before from.

Default: Current date and time
meetingId
string

Unique identifier for the parent meeting series, scheduled meeting or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series; if a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting; if a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all meetings of the current user.

Response Properties
items
array

An array of recording objects.

id
string

A unique identifier for recording.

meetingId
string

Unique identifier for the parent ended meeting instance which the recording belongs to.

scheduledMeetingId
string

Unique identifier for the parent scheduled meeting which the recording belongs to.

meetingSeriesId
string

Unique identifier for the parent meeting series which the recording belongs to.

topic
string

The recording's topic.

createTime
string

The date and time recording was created in ISO 8601 compliant format.

downloadUrl
string

The download link for recording. This attribute is not available if prevent downloading has been turned on for the recording being requested. The prevent downloading option can be viewed and set on page when editing a recording.

playbackUrl
string

The playback link for recording.

password
string

The recording's password.

format
enum
MP4

Recording file format is MP4.

ARF

Recording file format is ARF, a private format of Webex recordings. This format requires the Cisco ARF recording player.

durationSeconds
number

The duration of the recording, in seconds.

sizeBytes
number

The size of the recording file, in bytes.

shareToMe
boolean

Whether or not the recording has been shared to the current user.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/recordings{?max,from,to,meetingId}
Log in to try the API.
Header
Query Parameters
  • Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.
  • Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after current date and time or after `to`.
  • Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be after current date and time or before `from`.
  • Unique identifier for the parent meeting series, scheduled meeting or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series; if a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting; if a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all meetings of the current user.
https://webexapis.com/v1/recordings?from=2020-07-12T09:30:00+08:00&to=2020-07-31T09:30:00+08:00&meetingId=f91b6edce9864428af084977b7c68291_I_166641849979635652
200 / OK
{
    "items": [
        {
            "id": "4f914b1dfe3c4d11a61730f18c0f5387",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:35Z",
            "downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
            "playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
            "password": "BgJep@43",
            "format": "MP4",
            "durationSeconds": 18416,
            "sizeBytes": 168103,
            "shareToMe": false
        },
        {
            "id": "3324fb76946249cfa07fc30b3ccbf580",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:34Z",
            "downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=8a763939dec1fa26c565700d628fcb98",
            "playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b05e9c4f773745e7b88725cc97bc3161",
            "password": "BgJep@43",
            "format": "MP4",
            "durationSeconds": 181562,
            "sizeBytes": 199134,
            "shareToMe": false
        },
        {
            "id": "42b80117a2a74dcf9863bf06264f8075",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:33Z",
            "downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=0edd48adbb183e7da97884a0a984e877",
            "playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b64b28ebf70e4645954420c295a9fcad",
            "password": "BgJep@4",
            "format": "MP4",
            "durationSeconds": 181562,
            "sizeBytes": 199134,
            "shareToMe": true
        }
    ]
}