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
: Time zone in conformance with the IANA time zone database. The default is UTC iftimezone
is not defined.
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
.
Response Properties
An array of recording audit report objects.
A unique identifier for the recording.
The recording's topic.
The name of the person who accessed the recording.
The email address of the person who accessed the recording.
The date and time the recording was accessed in ISO 8601 compliant format.
Whether or not the recording was viewed by the person.
Whether or not the recording was downloaded by the person.
Response Codes
The list below describes the common success and error responses you should expect from the API.
Code | Status | Description |
---|---|---|
200 | OK | Successful request with body content. |
201 | Created | The request has succeeded and has led to the creation of a resource. |
202 | Accepted | The request has been accepted for processing. |
204 | No Content | Successful request without body content. |
400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
401 | Unauthorized | Authentication credentials were missing or incorrect. |
403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
404 | Not Found | The 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. |
405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
409 | Conflict | The 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. |
410 | Gone | The requested resource is no longer available. |
415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
423 | Locked | The 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. |
428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
429 | Too Many Requests | Too 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. |
500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
503 | Service Unavailable | Server is overloaded with requests. Try again later. |
504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
- timezone
Query Parameters
- recordingIdstringRequiredA unique identifier for the recording.
- hostEmailstringEmail 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.
- maxnumberMaximum 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`.
{ "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 } ] }