Converged Recordings - List Recordings

List Recordings

List recordings. You can specify a date range, 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.

List recordings requires the spark:recordings_read scope.

Request Header

timezone: Time zone in conformance with the IANA time zone database. The default is UTC if timezone is not defined.

GET/v1/convergedRecordings

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.

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.

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

serviceType

string

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

Possible values: calling

format

string

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

Possible values: MP3

ownerType

string

Recording based on type of user.

Possible values: user, place, virtualLine

storageRegion

string

Recording stored in certain Webex locations.

Possible values: US, SG, GB, JP, DE, AU, IN, CA

locationId

string

Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub).

topic

string

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

Response Properties

items

array[RecordingObject]

An array of recording objects.

string

A unique identifier for the recording.

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.

format

enum

MP3

string

Recording file format is MP3.

serviceType

enum

calling

string

Recording service type is Webex Call.

durationSeconds

number

The duration of the recording, in seconds.

sizeBytes

number

The size of the recording file, in bytes.

status

enum

available

string

Recording is available.

deleted

string

Recording has been moved into recycle bin.

ownerId

string

Webex UUID for recording owner/host.

ownerEmail

string

Webex email for recording owner/host.

ownerType

enum

user

string

Recording belongs to a user.

place

string

Recording belongs to a workspace device.

virtualLine

string

Recording belongs to a workspace device.

storageRegion

string

Storage location for recording within Webex datacenters.

serviceData

object

Fields relevant to each service Type.

locationId

string

Webex calling location for recording user.

callSessionId

string

Call ID for which recording was done.

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.

GET

/v1/convergedRecordings{?max,from,to,status,serviceType,format,ownerType,storageRegion,locationId,topic}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.
timezone

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`.
from
string
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`.
to
string
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`.
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.
serviceType
string
Recording's service-type. If this item is specified, the API filters recordings by service-type. Valid values are `calling`.
format
string
Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`.
ownerType
string
Recording based on type of user.
storageRegion
string
Recording stored in certain Webex locations.
locationId
string
Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub).
topic
string
Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.

https://webexapis.com/v1/convergedRecordings?from=2020-07-12T09:30:00+08:00&to=2020-07-31T09:30:00+08:00&status=%5Bobject%20Object%5D,%5Bobject%20Object%5D&serviceType=%5Bobject%20Object%5D&format=%5Bobject%20Object%5D&ownerType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&storageRegion=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&locationId=02a43ee9-17ae-4e0c-9e79-720e3a6503fd&topic=Call%20with%20User7

200 / OK

{
    "items": [
                {
                    "id": "ea0efc7c-f83a-4972-b0eb-c0f30cff5e61",
                    "topic": "Call with TestUser6 WebexCRP-20241004 1624",
                    "createTime": "2024-10-04T16:24:25Z",
                    "timeRecorded": "2024-10-04T16:20:20Z",
                    "ownerId": "a6aad220-e520-4529-a191-e84a72c0c9c2",
                    "ownerType": "user",
                    "ownerEmail": "nshtestwebex+testuser7@gmail.com",
                    "format": "MP3",
                    "durationSeconds": 23,
                    "sizeBytes": 74222,
                    "serviceType": "calling",
                    "storageRegion": "US",
                    "status": "available",
                    "serviceData": {
                        "locationId": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd",
                        "callSessionId": "b51c62ea-bbf6-4828-8959-1e41d8752022"
                    }
                },
                {
                    "id": "518cdca4-61c7-47dc-840b-29827d0cb62d",
                    "topic": "call with title",
                    "createTime": "2024-10-30T22:30:53Z",
                    "timeRecorded": "2024-10-30T22:17:19Z",
                    "ownerId": "d7468402-e95f-42a9-92c8-dd65f45d40ba",
                    "ownerType": "user",
                    "ownerEmail": "nshtestwebex+testuser7@gmail.com",
                    "format": "MP3",
                    "durationSeconds": 60,
                    "sizeBytes": 244326,
                    "serviceType": "calling",
                    "storageRegion": "US",
                    "status": "available",
                    "serviceData": {
                        "locationId": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd",
                        "callSessionId": "7ba29675-3016-4bf0-af19-66cf2854b000"
                    }
                }
            ]
}