DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex ConnectInstant ConnectDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
API Behavior ChangesPartners API GuideXML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP BasicsUsing Webex Service AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording 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 GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksUsing Webex Service AppsWebinar 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 AuthorizationWebhooksUsing Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDECT Devices SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording 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 TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooksWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

List Recordings For an Admin or Compliance Officer

List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.

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. Please note that when meetingId is specified, parameter of siteUrl will be ignored.

  • If siteUrl is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the 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/admin/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. The interval between from and to must be within 30 days.

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 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. The interval between from and to must be within 30 days.

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 not specified, the operation returns an array of recordings for all the current user's meetings. When meetingId is specified, the siteUrl parameter is ignored.

siteUrl
string

URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by 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 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.

Possible values: MP4, ARF
serviceType
string

The service type for recordings. If specified, the API filters recordings by service type.

Possible 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 to the recycle bin.

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

An array of recording objects.

id
string

A unique identifier for the recording.

meetingId
string

Unique identifier for the recording's ended meeting instance.

scheduledMeetingId
string

Unique identifier for the recording's scheduled meeting instance.

meetingSeriesId
string

Unique identifier for the recording's meeting series.

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.

hostDisplayName
string

Display name for the meeting host.

hostEmail
string

Email address for the meeting host.

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 proprietary Webex recording format.

UPLOADED
string

The recording file is uploaded manually.

serviceType
enum

The service type for the recording.

MeetingCenter
string

The service type for the recording is meeting.

EventCenter
string

The service type for the recording is the event.

TrainingCenter
string

The service type for the recording is the training session.

SupportCenter
string

The service type for the recording is the support meeting.

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/admin/recordings{?max,from,to,meetingId,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`. The interval between `from` and `to` must be within 30 days.
  • 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`. The interval between `from` and `to` must be within 30 days.
  • 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 the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.
  • URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [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 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.
  • The service type for recordings. If specified, the API filters recordings by service type.
  • Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved to the recycle bin.
  • Request
  • Response
https://webexapis.com/v1/admin/recordings?from=2020-07-12T09:30:00+08:00&to=2020-07-31T09:30:00+08:00&meetingId=f91b6edce9864428af084977b7c68291_I_166641849979635652&siteUrl=example.webex.com&integrationTag=dbaeceebea5c4a63ac9d5ef1edfe36b9&topic=John's%20Meeting&format=%5Bobject%20Object%5D,%5Bobject%20Object%5D&serviceType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&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",
            "hostDisplayName": "John Andersen",
            "hostEmail": "john.andersen@example.com",
            "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,
            "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",
            "hostDisplayName": "John Andersen",
            "hostEmail": "john.andersen@example.com",
            "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,
            "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",
            "hostDisplayName": "John Andersen",
            "hostEmail": "john.andersen@example.com",
            "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 Community

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.