{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Features: Call Recording API", "version": "1.0.0" }, "items": [ { "info": { "name": "Features: Call Recording", "type": "folder" }, "items": [ { "info": { "name": "Get Call Recording Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Retrieve call recording settings from this organization." } ] }, "docs": "Retrieve call recording settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nRetrieving call recording settings requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Call Recording Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/callRecording", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Retrieve call recording settings from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update call recording settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nUpdating call recording settings requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: This API is for Cisco partners only." }, { "info": { "name": "Get Call Recording Terms Of Service Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording/vendors/:vendorId/termsOfService", "params": [ { "name": "vendorId", "value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw", "type": "path", "description": "Retrieve call recording terms of service details for the given vendor." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Retrieve call recording terms of service details from this organization." } ] }, "docs": "Retrieve call recording terms of service settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nRetrieving call recording terms of service settings requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Call Recording Terms Of Service Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/callRecording/vendors/:vendorId/termsOfService", "params": [ { "name": "vendorId", "value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw", "type": "path", "description": "Update call recording terms of service settings for the given vendor." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Update call recording terms of service settings from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update call recording terms of service settings for the given vendor.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nUpdating call recording terms of service settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get details for the organization Compliance Announcement Setting", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording/complianceAnnouncement", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve compliance announcement setting from this organization." } ] }, "docs": "Retrieve the organization compliance announcement settings.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nRetrieving organization compliance announcement setting requires a full or read-only administrator auth token with " }, { "info": { "name": "Update the organization Compliance Announcement", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/callRecording/complianceAnnouncement", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update the compliance announcement setting from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the organization compliance announcement.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nUpdating the organization compliance announcement requires a full administrator auth token with a scope of `spark-admin:teleph" }, { "info": { "name": "Get details for the Location Compliance Announcement Setting", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/complianceAnnouncement", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Retrieve compliance announcement settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve compliance announcement setting from this organization." } ] }, "docs": "Retrieve the location compliance announcement settings.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nRetrieving location compliance announcement setting requires a full or read-only administrator auth token with a scope " }, { "info": { "name": "Update the Location Compliance Announcement", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/complianceAnnouncement", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Update the compliance announcement settings for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update the compliance announcement setting from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the location compliance announcement.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nUpdating the location compliance announcement requires a full administrator auth token with a scope of `spark-admin:telephony_conf" }, { "info": { "name": "Get Call Recording Regions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording/regions", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve call recording regions for this organization." } ] }, "docs": "Retrieve all the call recording regions that are available for an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Call Recording Vendor Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording/vendorUsers", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve call recording vendor users for this organization." }, { "name": "max", "value": "10", "type": "query", "description": "Limit the number of vendor users returned to this maximum count. The default is 2000." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects. The default is 0." }, { "name": "standardUserOnly", "value": "true", "type": "query", "description": "If true, results only include Webex Calling standard users." } ] }, "docs": "Retrieve call recording vendor users of an organization. This API is used to get the list of users who are assigned to the default call-recording vendor of the organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administ" }, { "info": { "name": "Set Call Recording Vendor for a Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendor", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj", "type": "path", "description": "Update the call recording vendor for this location" }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update the call recording vendor for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign a call recording vendor to a location of an organization. Response will be `204` if the changes can be applied immediatley otherwise `200` with a job ID is returned.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administr" }, { "info": { "name": "Get Location Call Recording Vendors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendors", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj", "type": "path", "description": "Retrieve vendor details for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve vendor details for this organization." } ] }, "docs": "Retrieve details of the call recording vendor that the location is assigned and also a list of vendors.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Call Recording Vendor Users for a Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendorUsers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj", "type": "path", "description": "Retrieve vendor users for this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve vendor users for this organization." }, { "name": "max", "value": "10", "type": "query", "description": "Limit the number of vendor users returned to this maximum count. The default is 2000." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects. The default is 0." }, { "name": "standardUserOnly", "value": "true", "type": "query", "description": "If true, results only include Webex Calling standard users." } ] }, "docs": "Retrieve call recording vendor users of a location. This API is used to get the list of users assigned to the call recording vendor of the location.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a s" }, { "info": { "name": "List Call Recording Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/callRecording", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List call recording jobs in this organization." }, { "name": "max", "value": "10", "type": "query", "description": "Limit the number of jobs returned to this maximum count. The default is 50." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects. The default is 0." } ] }, "docs": "Get the list of all call recording jobs in an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get the Job Status of a Call Recording Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/callRecording/:jobId", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job status for this `jobId`." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve job status in this organization." } ] }, "docs": "Get the details of a call recording job by its job ID.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Job Errors for a Call Recording Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/jobs/callRecording/:jobId/errors", "params": [ { "name": "jobId", "value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU", "type": "path", "description": "Retrieve job errors for this job." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve job errors for a call recording job in this organization." }, { "name": "max", "value": "10", "type": "query", "description": "Limit the number of errors returned to this maximum count. The default is 50." } ] }, "docs": "Get errors for a call recording job in an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Organization Call Recording Vendors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRecording/vendors", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Retrieve call recording settings from this organization." } ] }, "docs": "Returns what the current vendor is as well as a list of all the available vendors.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Set Organization Call Recording Vendor", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/callRecording/vendor", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU", "type": "query", "description": "Modify call recording settings from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a Job ID that you can use to get the status of the job.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`, `spark-admin:telephony_config_read`, and `spark-admi" } ] } ], "bundled": true }