APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
API Changelog

Get Recording Audit Report Details

Retrieves details for a recording audit report with a specified recording ID.

Only recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.

Request Header
  • timezone: specific the timezone with timezone header defined in conformance with the IANA time zone database. The default is UTC if timezone is not defined.
GET/v1/recordingReport/accessDetail
Query Parameters
recordingId
stringrequired

A unique identifier for the recording.

hostEmail
string

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

max
number

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

Default: 10
Response Properties
items
array[RecordingReportObject]

An array of recording audit report objects.

recordingId
string

A unique identifier for the recording.

topic
string

The recording's topic.

name
string

The name of the person who accessed the recording.

email
string

The email address of the person who accessed the recording.

accessTime
string

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

viewed
boolean

The recording was viewed.

downloaded
boolean

The recording was downloaded.

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/recordingReport/accessDetail{?recordingId,hostEmail,max}
Log in to try the API.
Header
Query Parameters
  • A unique identifier for the recording.
  • Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.
  • Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.
https://webexapis.com/v1/recordingReport/accessDetail?recordingId=4f914b1dfe3c4d11a61730f18c0f5387&hostEmail=john.andersen@example.com
200 / OK
{
    "items": [
        {
            "recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
            "topic": "Example Topic",
            "name": "John Andersen",
            "email": "john.andersen@example.com",
            "accessTime": "2020-07-13T17:05:35Z",
            "viewed": true,
            "downloaded": false
           },
        {
            "recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
            "topic": "Example Topic",
            "name": "Brenda Song",
            "email": "brenda.song@example.com",
            "accessTime": "2020-07-18T19:05:35Z",
            "viewed": false,
            "downloaded": true
           },
       {
            "recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
            "topic": "Example Topic",
            "name": "Joe Doe",
            "email": "joeDoe@example.com",
            "accessTime": "2020-08-18T19:08:33Z",
            "viewed": true,
            "downloaded": true
           }
    ]
}