DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordings
GETList Recordings
GETList Recordings For an Admin or Compliance Officer
GETGet Recording Details
DELETEDelete a Recording
POSTMove Recordings into the Recycle Bin
POSTRestore Recordings from Recycle Bin
POSTPurge Recordings from Recycle Bin
Report TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordings
GETList Recordings
GETList Recordings For an Admin or Compliance Officer
GETGet Recording Details
DELETEDelete a Recording
POSTMove Recordings into the Recycle Bin
POSTRestore Recordings from Recycle Bin
POSTPurge Recordings from Recycle Bin
Session TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordings
GETList Recordings
GETList Recordings For an Admin or Compliance Officer
GETGet Recording Details
DELETEDelete a Recording
POSTMove Recordings into the Recycle Bin
POSTRestore Recordings from Recycle Bin
POSTPurge Recordings from Recycle Bin
Report TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

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.

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.

  • If meetingId is specified, only recordings associated with the specified meeting will be listed. NOTE: when meetingId is specified, parameter of siteUrl will be ignored.

  • If siteUrl is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.

Request Header
  • timezone: Time zone in conformance with the IANA time zone database. The default is UTC if timezone is not defined.
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 to.

Default: If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the 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 before from.

Default: If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the 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 no ID is specified, the operation returns an array of recordings for all meetings of the current user. When meetingId is specified, the siteUrl parameter is ignored.

hostEmail
string

Email address for the meeting host. This parameter is only used if the user or application calling the API has the required admin-level meeting scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.

siteUrl
string

URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the Get Site List API.

integrationTag
string

External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.

topic
string

Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.

format
string

Recording's file format. If specified, the API filters recordings by format. Valid values are MP4 or ARF.

serviceType
string

Recording's service-type. If this item is specified, the API filters recordings by service-type. Valid values:

  • MeetingCenter

  • EventCenter

  • SupportCenter

  • TrainingCenter

status
string

Recording's status. If not specified or available, retrieves recordings that are available. Otherwise, if specified as deleted, retrieves recordings that have been moved into the recycle bin.

Possible values: available, deleted
Default: available
Response Properties
items
array[RecordingObject]

An array of recording objects.

id
string

A unique identifier for the 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. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline.

timeRecorded
string

The date and time recording started in ISO 8601 compliant format. It indicates when the record button was clicked in the meeting.

siteUrl
string

Site URL for the recording.

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 by a site admin on Control Hub.

playbackUrl
string

The playback link for recording.

password
string

The recording's password.

format
enum
MP4
string

Recording file format is MP4.

ARF
string

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

serviceType
enum
MeetingCenter
string

Recording service-type is MeetingCenter.

EventCenter
string

Recording service-type is EventCenter.

SupportCenter
string

Recording service-type is SupportCenter.

TrainingCenter
string

Recording service-type is TrainingCenter.

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.

integrationTags
array[string]

External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain.

status
enum
available
string

Recording is available.

deleted
string

Recording has been moved into recycle bin.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
GET
/v1/recordings{?max,from,to,meetingId,hostEmail,siteUrl,integrationTag,topic,format,serviceType,status}
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 `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 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 no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.
  • Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.
  • URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
  • External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.
  • Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.
  • Recording's file format. If specified, the API filters recordings by format. Valid values are `MP4` or `ARF`.
  • Recording's service-type. If this item is specified, the API filters recordings by service-type. Valid values: + `MeetingCenter` + `EventCenter` + `SupportCenter` + `TrainingCenter`
  • Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin.
  • Request
  • Response
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&hostEmail=john.andersen@example.com&siteUrl=example.webex.com&integrationTag=dbaeceebea5c4a63ac9d5ef1edfe36b9&topic=John's%20Meeting&format=ARF&serviceType=MeetingCenter&status=%5Bobject%20Object%5D,%5Bobject%20Object%5D
200 / OK
{
    "items": [
        {
            "id": "4f914b1dfe3c4d11a61730f18c0f5387",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:35Z",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "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": "ARF",
            "serviceType": "MeetingCenter",
            "durationSeconds": 18416,
            "sizeBytes": 168103,
            "shareToMe": false,
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ],
            "status": "available"
        },
        {
            "id": "3324fb76946249cfa07fc30b3ccbf580",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:34Z",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "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": "ARF",
            "serviceType": "MeetingCenter",
            "durationSeconds": 181562,
            "sizeBytes": 199134,
            "shareToMe": false,
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ],
            "status": "available"
        },
        {
            "id": "42b80117a2a74dcf9863bf06264f8075",
            "meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
            "scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
            "meetingSeriesId": "f91b6edce9864428af084977b7c68291",
            "topic": "Example Topic",
            "createTime": "2020-07-13T17:11:33Z",
            "timeRecorded": "2020-07-13T17:05:35Z",
            "siteUrl": "site4-example.webex.com",
            "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": "ARF",
            "serviceType": "MeetingCenter",
            "durationSeconds": 181562,
            "sizeBytes": 199134,
            "shareToMe": true,
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ],
            "status": "available"
        }
    ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.