{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Converged Recordings API", "version": "1.0.0" }, "items": [ { "info": { "name": "Converged Recordings", "type": "folder" }, "items": [ { "info": { "name": "List Recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/convergedRecordings", "headers": [ { "name": "timezone", "value": "UTC" } ], "params": [ { "name": "max", "value": "", "type": "query", "description": "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`." }, { "name": "from", "value": "2020-07-12T09:30:00+08:00", "type": "query", "description": "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`." }, { "name": "to", "value": "2020-07-31T09:30:00+08:00", "type": "query", "description": "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`." }, { "name": "status", "value": "available", "type": "query", "description": "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." }, { "name": "serviceType", "value": "calling", "type": "query", "description": "Recording's service-type. If specified, the API filters recordings by service-type. Valid values are `calling` and `customerAssist`." }, { "name": "format", "value": "MP3", "type": "query", "description": "Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`." }, { "name": "ownerType", "value": "user", "type": "query", "description": "Recording based on type of user." }, { "name": "storageRegion", "value": "US", "type": "query", "description": "Recording stored in certain Webex locations." }, { "name": "locationId", "value": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd", "type": "query", "description": "Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub)." }, { "name": "topic", "value": "Call with User7", "type": "query", "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner." } ] }, "docs": "List recordings. You can specify a date range, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\nList recordings requires the `spark:recordings_read` scope.\n\nPlease use `List Recordings for Admin or Compliance Officer` API to list all recordings for a user with the role Compliance officer or Admin\n\nRequest Header\n\n* `timezone`: " }, { "info": { "name": "List Recordings for Admin or Compliance officer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/convergedRecordings", "headers": [ { "name": "timezone", "value": "UTC" } ], "params": [ { "name": "max", "value": "", "type": "query", "description": "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`." }, { "name": "from", "value": "2020-07-12T09:30:00+08:00", "type": "query", "description": "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." }, { "name": "to", "value": "2020-07-31T09:30:00+08:00", "type": "query", "description": "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." }, { "name": "status", "value": "available", "type": "query", "description": "Recording's status. If not specified or `available`, retrieves recordings that are available. if specified as `purged`, retrieves recordings those are deleted but available to a compliance officer. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin." }, { "name": "serviceType", "value": "calling", "type": "query", "description": "Recording's service-type. If specified, the API filters recordings by service-type. Valid values are `calling` and `customerAssist`." }, { "name": "format", "value": "MP3", "type": "query", "description": "Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`." }, { "name": "ownerId", "value": "24683d6c-5529-4b60-a6c7-91e8b293bbab", "type": "query", "description": "Webex user Id to fetch recordings for a particular user." }, { "name": "ownerEmail", "value": "john.andersen@example.com", "type": "query", "description": "Webex email address to fetch recordings for a particular user." }, { "name": "ownerType", "value": "user", "type": "query", "description": "Recording based on type of user." }, { "name": "storageRegion", "value": "US", "type": "query", "description": "Recording stored in certain Webex locations." }, { "name": "locationId", "value": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd", "type": "query", "description": "Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub)." }, { "name": "topic", "value": "Call with User7", "type": "query", "description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner." } ] }, "docs": "List recordings for an admin or compliance officer. You can specify a date range, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\nList recordings requires the `spark-compliance:recordings_read` scope for compliance officer and `spark-admin:recordings_read` scope for admin.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https" }, { "info": { "name": "Get Recording Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/convergedRecordings/:recordingId", "headers": [ { "name": "timezone", "value": "UTC" } ], "params": [ { "name": "recordingId", "value": "62807eaf-0c89-492e-a3c3-c4751812603b", "type": "path", "description": "A unique identifier for the recording." } ] }, "docs": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of owner with the authenticated user may be retrieved.\n\nGet Recording Details requires the `spark-compliance:recordings_read` scope for compliance officer, `spark-admin:recordings_read` scope for admin and `spark:recordings_read` scope for user.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https:" }, { "info": { "name": "Delete a Recording", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/convergedRecordings/:recordingId", "params": [ { "name": "recordingId", "value": "4f914b1dfe3c4d11a61730f18c0f5387", "type": "path", "description": "A unique identifier for the recording." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered.\n\nIf a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), and to the Compliance officer as well. This action purges the recordings from Webex.\n\nDelete a Recording requires the `spark-compliance:recordings_write` scope." }, { "info": { "name": "Get Recording metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/convergedRecordings/:recordingId/metadata", "params": [ { "name": "recordingId", "value": "4f914b1dfe3c4d11a61730f18c0f5387", "type": "path", "description": "A unique identifier for the recording." }, { "name": "showAllTypes", "value": "false", "type": "query", "description": "If `showAllTypes` is `true`, all attributes will be shown. If it's `false` or not specified, the following attributes of the metadata will be hidden.\n serviceData.callActivity.mediaStreams\n serviceData.callActivity.participants\n serviceData.callActivity.redirectInfo\n serviceData.callActivity.redirectedCall\n" } ] }, "docs": "Retrieves metadata details for a recording with a specified recording ID. The recording must be owned by the authenticated user.\n\nFor information on the metadata fields, refer to [Metadata Guide](https://developer.webex.com/docs/api/guides/consolidated-metadata-documentation-and-samples-guide)\n\nGet Recording metadata requires the `spark-compliance:recordings_read` scope for compliance officer, `spark-admin:recordings_read` for admin and `spark:recordings_read` for user." }, { "info": { "name": "Reassign Recordings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/convergedRecordings/reassign", "body": { "type": "json", "data": "{}" } }, "docs": "Reassigns recordings to a new user. As an administrator, you can reassign a list of recordings or all recordings of a particular user to a new user.\nThe recordings can belong to an org user, a virtual line, or a workspace, but the destination user should only be a valid org user.\n\n* For a org user either `ownerEmail` or `recordingIds` or both must be provided.\n\n* For a virtual line or a workspace, `ownerID` or `recordingIds` or both must be provided.\n\n* If `recordingIds` and `ownerID` is empty b" }, { "info": { "name": "Move Recordings into the Recycle Bin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/convergedRecordings/softDelete", "body": { "type": "json", "data": "{}" } }, "docs": "Move recordings into the recycle bin with recording IDs or move all the recordings to the recycle bin.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can move a list of recordings or all recordings of a particular user within the org you manage to the rec" }, { "info": { "name": "Restore Recordings from Recycle Bin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/convergedRecordings/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore recordings from the recycle bin with recording IDs or restore all the recordings that are in the recycle bin.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can restore a list of recordings or all recordings of a particular user within the org you" }, { "info": { "name": "Purge Recordings from Recycle Bin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/convergedRecordings/purge", "body": { "type": "json", "data": "{}" } }, "docs": "Purge recordings from the recycle bin matching the supplied recording IDs, or purge all the recordings that are in the recycle bin. A recording, once purged, cannot be restored.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can purge a list of recordings" } ] } ], "bundled": true }