openapi: 3.0.0 info: title: Webex Admin Address Book Workspace Call Settings (2/2) API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Workspace Call Settings (2/2) paths: /telephony/config/workspaces/{workspaceId}/musicOnHold: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetMusicOnHoldObject' example: mohEnabled: true mohLocationEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Music On Hold Settings for a Workspace operationId: Retrieve Music On Hold Settings for a Workspace description: 'Retrieve Music On Hold Settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving a workspace''s music on hold settings requires a full, device or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Music On Hold Settings for a Workspace operationId: Modify Music On Hold Settings for a Workspace description: 'Modify music on hold settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold setting for a workspace, music on hold setting must be enabled for this location. This API requires a full or device administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: mohEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/PutMusicOnHoldObject' /telephony/config/workspaces/{workspaceId}/features/accessCodes/{accessCode}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Specific Access Code for a Workspace operationId: Delete a Specific Access Code for a Workspace description: 'Deletes a specific access code for the given workspace. Access codes are used to bypass permissions. This API requires a full, device or location administrator auth token with the scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: accessCode in: path description: Access code for outgoing calls. required: true example: '1234' schema: type: string /telephony/config/workspaces/{workspaceId}/outgoingPermission/digitPatterns: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceOutgoingPermissionDigitPatternGetListObject' example: useCustomDigitPatterns: false digitPatterns: - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern1 pattern: 2XXXX action: ALLOW transferEnabled: false - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V5 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve all Digit Patterns for a Workspace operationId: Retrieve all Digit Patterns for a Workspace description: 'Retrieve all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created digit pattern. example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Digit Pattern for a Workspace operationId: Create Digit Pattern for a Workspace description: 'Create a new digit pattern for the given workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: DigitPattern3 pattern: 3XXX action: ALLOW transferEnabled: false schema: $ref: '#/components/schemas/WorkspaceOutgoingPermissionDigitPatternPostObject' put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify the Digit Pattern Category Control Settings for the Workspace operationId: Modify the Digit Pattern Category Control Settings for the Workspace description: 'Modifies whether this workspace uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomDigitPatterns: true schema: $ref: '#/components/schemas/WorkspaceOutgoingPermissionDigitPatternCategoryControlPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete all Digit Patterns for a Workspace operationId: Delete all Digit Patterns for a Workspace description: 'Delete all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/outgoingPermission/digitPatterns/{digitPatternId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceDigitPatternObject' example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve a Digit Pattern details for the Workspace operationId: Retrieve a Digit Pattern details for the Workspace description: 'Retrieve the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Digit Pattern for the Workspace operationId: Modify a Digit Pattern for the Workspace description: 'Modify the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: DigitPattern4 pattern: 3XXX2 schema: $ref: '#/components/schemas/WorkspaceOutgoingPermissionDigitPatternPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Digit Pattern for the Workspace operationId: Delete a Digit Pattern for the Workspace description: 'Delete a digit pattern for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/features/intercept/actions/announcementUpload/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Upload Call Intercept Announcement file for a Workspace operationId: Upload Call Intercept Announcement file for a Workspace description: 'Upload call intercept announcement file for a workspace. The upload announcement feature for a call intercept is used to play custom announcements for a workspace. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full, device or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: orgId in: query description: Create an announcement in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string /telephony/config/workspaces/{workspaceId}/features/callRecordings: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallRecordingInfo' example: enabled: true record: Never recordVoicemailEnabled: false notification: enabled: true type: None repeat: interval: 15 enabled: false serviceProvider: WSWYZ25455 externalGroup: WSWYZ25455L31161 externalIdentifier: a34iidrh5o@64941297.int10.bcld.webex.com startStopAnnouncement: internalCallsEnabled: false pstnCallsEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Call Recording Settings for a Workspace operationId: Retrieve Call Recording Settings for a Workspace description: 'Retrieve call recording settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more. This API requires a full, read-only, device or location administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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.' headers: {} content: application/json: schema: $ref: '#/components/schemas/callRecordingResponse' example: vendorId: 53dc4c87-8408-4882-9570-dca2bcdb9280 vendorName: Dubber termsOfServiceUrl: https://www.dubber.net/terms '410': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Call Recording Settings for a Workspace operationId: Modify Call Recording Settings for a Workspace description: 'Modify call forwarding settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more. The vendor''s terms of service have to be accepted to enable call recording. Vendor details along with the terms of service URL are shared when the vendor''s terms of service are not accepted yet. This API requires a full, device or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true record: Always with Pause/Resume notification: enabled: true type: Play Announcement recordVoicemailEnabled: true repeat: enabled: true startStopAnnouncement: internalCallsEnabled: true pstnCallsEnabled: true schema: $ref: '#/components/schemas/CallRecordingPut' /telephony/config/workspaces/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false includedTelephonyTypes: PSTN_NUMBER isServiceNumber: false telephonyType: PSTN_NUMBER - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace Available Phone Numbers operationId: Get Workspace Available Phone Numbers description: 'List standard numbers that are available to be assigned as a workspace''s phone number. By default, this API returns numbers from all locations that are unassigned. To select the suitable number for assignment, ensure the workspace''s location ID is provided as the `locationId` request parameter. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceECBNAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NWQ3MmYwNS00NDYzLTQxYzktYjI0Ni01MDhkMDM2YzJhOTE type: VIRTUAL_LINE displayName: Test VL - phoneNumber: '+12056350004' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWnpOcmEybHNkalV3ZDBCbWJHVjRNaTVqYVhOamJ5NWpiMjA9 type: HUNT_GROUP displayName: Test HG '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace ECBN Available Phone Numbers operationId: Get Workspace ECBN Available Phone Numbers description: 'List standard numbers that are available to be assigned as a workspace''s emergency callback number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string /telephony/config/workspaces/{workspaceId}/callForwarding/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceCallForwardAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYm1kMmVIcHNabTgwWVVBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: CALL_QUEUE displayName: Test call queue '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace Call Forward Available Phone Numbers operationId: Get Workspace Call Forward Available Phone Numbers description: 'List the service and standard PSTN numbers that are available to be assigned as a workspace''s call forward number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/workspaces/{workspaceId}/callIntercept/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceCallInterceptAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2RtbHRNWFV6WjJkaWRFQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09 type: AUTO_ATTENDANT displayName: Test Autoattendant '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace Call Intercept Available Phone Numbers operationId: Get Workspace Call Intercept Available Phone Numbers description: 'List the service and standard PSTN numbers that are available to be assigned as a workspace''s call intercept number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/workspaces/{workspaceId}/anonymousCallReject: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AnonymousCallRejectionGet' example: enabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Anonymous Call Settings for a Workspace operationId: Retrieve Anonymous Call Settings for a Workspace description: 'Retrieve Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Anonymous Call Settings for a Workspace operationId: Modify Anonymous Call Settings for a Workspace description: 'Modify Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/AnonymousCallRejectionPatch' /telephony/config/workspaces/{workspaceId}/bargeIn: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserBargeInGet' example: enabled: true toneEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Barge In Call Settings for a Workspace operationId: Retrieve Barge In Call Settings for a Workspace description: 'Retrieve Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Barge In Call Settings for a Workspace operationId: Modify Barge In Call Settings for a Workspace description: 'Modify Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false toneEnabled: false schema: $ref: '#/components/schemas/UserBargeInPatch' /telephony/config/workspaces/{workspaceId}/doNotDisturb: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceDoNotDisturbGet' example: enabled: true ringSplashEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve DoNotDisturb Settings for a Workspace operationId: Retrieve DoNotDisturb Settings for a Workspace description: 'Retrieve DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is available for professional and common area licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify DoNotDisturb Settings for a Workspace operationId: Modify DoNotDisturb Settings for a Workspace description: 'Modify DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional and common area licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false ringSplashEnabled: false schema: $ref: '#/components/schemas/PlaceDoNotDisturbPatch' /telephony/config/workspaces/{workspaceId}/callBridge: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallBridgeGet' example: warningToneEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Call Bridge Warning Tone Settings for a Workspace operationId: Retrieve Call Bridge Warning Tone Settings for a Workspace description: 'Retrieve Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Call Bridge Warning Tone Settings for a Workspace operationId: Modify Call Bridge Warning Tone Settings for a Workspace description: 'Modify Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: warningToneEnabled: false schema: $ref: '#/components/schemas/CallBridgePatch' /telephony/config/workspaces/{workspaceId}/pushToTalk: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PushToTalkInfo' example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com location: name: Paragville id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhjOWZkMjg1LTY1MDAtNDUxOC04NTZlLWViODM2YzY3NjFkOA numbers: - external: '+19845551088' extension: '1088' primary: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE lastName: Johnson firstName: Bob displayName: Bob Johnson type: PEOPLE email: bob@example.com numbers: - external: '+198455501099' extension: '1099' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Push-to-Talk Settings for a Workspace operationId: Read Push-to-Talk Settings for a Workspace description: 'Retrieve Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Push-to-Talk Settings for a Workspace operationId: Configure Push-to-Talk Settings for a Workspace description: 'Configure Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE schema: $ref: '#/components/schemas/PushToTalkPut' /telephony/config/workspaces/{workspaceId}/privacy: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PrivacyGet' example: aaExtensionDialingEnabled: true aaNamingDialingEnabled: true enablePhoneStatusDirectoryPrivacy: true enablePhoneStatusPickupBargeInPrivacy: true monitoringAgents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMGMxYmFlNi1iMDU4LTRkYzItYmMyZC01NDYwOTFlOTkwOTk lastName: Doe firstName: John displayName: John Doe type: PEOPLE email: johnDoe@gmail.com numbers: - extension: '25789' esn: '25789' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Privacy Settings for a Workspace operationId: Retrieve Privacy Settings for a Workspace description: 'Retrieve Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` scope to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Privacy Settings for a Workspace operationId: Modify Privacy Settings for a Workspace description: 'Modify Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: aaExtensionDialingEnabled: true aaNamingDialingEnabled: true enablePhoneStatusDirectoryPrivacy: true enablePhoneStatusPickupBargeInPrivacy: true monitoringAgents: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kMWQyY2JmNy1jMTY5LTVlZDMtY2QzZS03NTcxMDJmMDAxMDA= - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMmUzZGNnOC1kMjcwLTZmZTQtZGU0Zi04NjgyMTNnMTEyMTE= schema: $ref: '#/components/schemas/PrivacyPatch' /telephony/config/workspaces/{workspaceId}/voicemail: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VoicemailInfo' example: enabled: true sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT greetingUploaded: false sendUnansweredCalls: enabled: false greeting: DEFAULT greetingUploaded: true numberOfRings: 3 systemMaxNumberOfRings: 20 notifications: enabled: true destination: julie@example.com transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Voicemail Settings for a Workspace operationId: Read Voicemail Settings for a Workspace description: 'Retrieve a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Voicemail Settings for a Workspace operationId: Configure Voicemail Settings for a Workspace description: 'Configure a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true notifications: enabled: true destination: julie@example.com sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT sendUnansweredCalls: enabled: false greeting: CUSTOM numberOfRings: 3 transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com schema: $ref: '#/components/schemas/VoicemailPut' /telephony/config/workspaces/{placeId}/voicemail/passcode: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Voicemail Passcode for a Workspace operationId: Modify Voicemail Passcode for a Workspace description: 'Modify voicemail passcode for a workspace. Modifying the voicemail passcode for a workspace requires a full administrator, device administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Workspace Call Settings (2/2) parameters: - name: placeId in: path description: Modify voicemail passcode for this workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzU2ZGIyNGQzLTdhN2EtNDBhMi05YWM5LWIyMzMyNzc5MjFO77+9 schema: type: string - name: orgId in: query description: Modify voicemail passcode for a workspace in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: passcode: '1551234' schema: $ref: '#/components/schemas/ModifyVoicemailPasscode' /telephony/config/workspaces/{workspaceId}/sequentialRing/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SequentialRingCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: false phoneNumbers: - '+442071838750' - '+442071839751' ringEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Sequential Ring Criteria for a Workspace operationId: Retrieve Sequential Ring Criteria for a Workspace description: 'Retrieve sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Sequential Ring Criteria for a Workspace operationId: Modify Sequential Ring Criteria for a Workspace description: 'Modify sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: false phoneNumbers: - '+442071838750' - '+442071839751' ringEnabled: true schema: $ref: '#/components/schemas/SequentialRingCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Sequential Ring Criteria for a Workspace operationId: Delete Sequential Ring Criteria for a Workspace description: 'Delete sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/callPolicies: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserCallPoliciesGet' example: connectedLineIdPrivacyOnRedirectedCalls: '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Policy Settings for a Workspace operationId: Read Call Policy Settings for a Workspace description: 'Retrieve a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Policy Settings for a Workspace operationId: Configure Call Policy Settings for a Workspace description: 'Configure a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: connectedLineIdPrivacyOnRedirectedCalls: schema: $ref: '#/components/schemas/UserCallPoliciesPatch' /telephony/config/workspaces/{workspaceId}/voicemail/actions/uploadBusyGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Busy Voicemail Greeting for a Place operationId: Configure Busy Voicemail Greeting for a Place description: 'Configure a workspace''s Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/voicemail/actions/uploadNoAnswerGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure No Answer Voicemail Greeting for a Place operationId: Configure No Answer Voicemail Greeting for a Place description: 'Configure a workspace''s No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/sequentialRing/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Sequential Ring Criteria for a Workspace operationId: Create Sequential Ring Criteria for a Workspace description: 'Create sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: false phoneNumbers: - '+442071838750' - '+442071839751' ringEnabled: true schema: $ref: '#/components/schemas/SequentialRingCriteriaPost' /telephony/config/workspaces/{workspaceId}/sequentialRing: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SequentialRingGet' example: enabled: true ringBaseLocationFirstEnabled: true baseLocationNumberOfRings: '2' continueIfBaseLocationIsBusyEnabled: true callsToVoicemailEnabled: true phoneNumbers: - phoneNumber: '+442071838750' answerConfirmationRequiredEnabled: true numberOfRings: 3 criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS ringEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Sequential Ring Settings for a Workspace operationId: Retrieve Sequential Ring Settings for a Workspace description: 'Retrieve sequential ring settings for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Sequential Ring Settings for a Workspace operationId: Modify Sequential Ring Settings for a Workspace description: 'Modify sequential ring settings for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true ringBaseLocationFirstEnabled: true baseLocationNumberOfRings: '2' continueIfBaseLocationIsBusyEnabled: true callsToVoicemailEnabled: true phoneNumbers: - phoneNumber: '+442071838750' answerConfirmationRequiredEnabled: true numberOfRings: 3 schema: $ref: '#/components/schemas/SequentialRingPatch' /telephony/config/workspaces/{workspaceId}/simultaneousRing: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SimultaneousRingGet' example: enabled: true doNotRingIfOnCallEnabled: true phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationRequiredEnabled: true - phoneNumber: '+19186663950' answerConfirmationRequiredEnabled: false criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS ringEnabled: true criteriasEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Simultaneous Ring Settings for a Workspace operationId: Retrieve Simultaneous Ring Settings for a Workspace description: 'Retrieve Simultaneous Ring Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Simultaneous Ring Settings for a Workspace operationId: Modify Simultaneous Ring Settings for a Workspace description: 'Modify Simultaneous Ring Settings for a Workspace. The Simultaneous Ring feature allows you to configure the workspace phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false doNotRingIfOnCallEnabled: false phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationRequiredEnabled: false criteriasEnabled: false schema: $ref: '#/components/schemas/SimultaneousRingPatch' /telephony/config/workspaces/{workspaceId}/simultaneousRing/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceSimultaneousRingCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' ringEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Simultaneous Ring Criteria for a Workspace operationId: Retrieve Simultaneous Ring Criteria for a Workspace description: 'Retrieve Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Simultaneous Ring Criteria for a Workspace operationId: Modify Simultaneous Ring Criteria for a Workspace description: 'Modify Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' ringEnabled: false schema: $ref: '#/components/schemas/PlaceSimultaneousRingCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Simultaneous Ring Criteria for a Workspace operationId: Delete Simultaneous Ring Criteria for a Workspace description: 'Delete simultaneous ring criteria Settings for a workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/simultaneousRing/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Simultaneous Ring Criteria for a Workspace operationId: Create Simultaneous Ring Criteria for a Workspace description: 'Create Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' ringEnabled: false schema: $ref: '#/components/schemas/PlaceSimultaneousRingCriteriaPost' /telephony/config/workspaces/{workspaceId}/selectiveReject: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveRejectCallGet' example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS rejectEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Reject Settings for a Workspace operationId: Retrieve Selective Reject Settings for a Workspace description: 'Retrieve Selective Reject Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Reject Settings for a Workspace operationId: Modify Selective Reject Settings for a Workspace description: 'Modify Selective Reject Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/SelectiveRejectCallSettingPatch' /telephony/config/workspaces/{workspaceId}/selectiveReject/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceSelectiveRejectCallCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' rejectEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Reject Criteria for a Workspace operationId: Retrieve Selective Reject Criteria for a Workspace description: 'Retrieve Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Reject Criteria for a Workspace operationId: Modify Selective Reject Criteria for a Workspace description: 'Modify Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' rejectEnabled: false schema: $ref: '#/components/schemas/PlaceSelectiveRejectCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Selective Reject Criteria for a Workspace operationId: Delete Selective Reject Criteria for a Workspace description: 'Delete Selective Reject criteria Settings for a workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/selectiveReject/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Selective Reject Criteria for a Workspace operationId: Create Selective Reject Criteria for a Workspace description: 'Create Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' rejectEnabled: false schema: $ref: '#/components/schemas/PlaceSelectiveRejectCallCriteriaPost' /telephony/config/workspaces/{workspaceId}/numbers: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Assign or Unassign numbers associated with a specific workspace operationId: Assign or Unassign numbers associated with a specific workspace description: 'Assign or unassign alternate phone numbers associated with a specific workspace. Each location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserNumbersPatch' /telephony/config/workspaces/{workspaceId}/selectiveAccept: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveAcceptCallGet' example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS acceptEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Accept Settings for a Workspace operationId: Retrieve Selective Accept Settings for a Workspace description: 'Retrieve Selective Accept Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Accept Settings for a Workspace operationId: Modify Selective Accept Settings for a Workspace description: 'Modify Selective Accept Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/SelectiveAcceptCallSettingPatch' /telephony/config/workspaces/{workspaceId}/selectiveAccept/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceSelectiveAcceptCallCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' acceptEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Accept Criteria for a Workspace operationId: Retrieve Selective Accept Criteria for a Workspace description: 'Retrieve Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Accept Criteria for a Workspace operationId: Modify Selective Accept Criteria for a Workspace description: 'Modify Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' acceptEnabled: false schema: $ref: '#/components/schemas/PlaceSelectiveAcceptCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Selective Accept Criteria for a Workspace operationId: Delete Selective Accept Criteria for a Workspace description: 'Delete Selective Accept criteria Settings for a workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/selectiveAccept/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Selective Accept Criteria for a Workspace operationId: Create Selective Accept Criteria for a Workspace description: 'Create Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' acceptEnabled: false schema: $ref: '#/components/schemas/PlaceSelectiveAcceptCallCriteriaPost' /telephony/config/workspaces/{workspaceId}/priorityAlert: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PriorityAlertGet' example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS notificationEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Priority Alert Settings for a Workspace operationId: Retrieve Priority Alert Settings for a Workspace description: 'Retrieve Priority Alert Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Priority Alert Settings for a Workspace operationId: Configure Priority Alert Settings for a Workspace description: 'Configure a workspace Priority Alert Settings. The priority alert feature enables administrator to configure priority alert settings for a professional workspace. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope that can be used to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/PriorityAlertPatch' /telephony/config/workspaces/{workspaceId}/priorityAlert/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlacePriorityAlertCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: Holidays scheduleLevel: GROUP callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' notificationEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Priority Alert Criteria for a Workspace operationId: Retrieve Priority Alert Criteria for a Workspace description: 'Retrieve Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace. Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Priority Alert Criteria for a Workspace operationId: Modify Priority Alert Criteria for a Workspace description: 'Modify Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace. Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week. This API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: Holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' notificationEnabled: false schema: $ref: '#/components/schemas/PlacePriorityAlertCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Priority Alert Criteria for a Workspace operationId: Delete Priority Alert Criteria for a Workspace description: 'Delete Priority Alert criteria Settings for a workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace. Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week. This API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/priorityAlert/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Priority Alert Criteria for a Workspace operationId: Create Priority Alert Criteria for a Workspace description: 'Create Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace. Priority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week. This API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: Holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' notificationEnabled: false schema: $ref: '#/components/schemas/PlacePriorityAlertCriteriaPost' /telephony/config/workspaces/{workspaceId}/selectiveForward: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveForwardCallGet' example: enabled: true defaultPhoneNumberToForward: '+1934898988' ringReminderEnabled: true destinationVoicemailEnabled: false criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: ALL_NUMBERS forwardEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Forward Settings for a Workspace operationId: Retrieve Selective Forward Settings for a Workspace description: 'Retrieve Selective Forward Call Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Forward Settings for a Workspace operationId: Modify Selective Forward Settings for a Workspace description: 'Modify Selective Forward Call Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false defaultPhoneNumberToForward: '+1934898988' ringReminderEnabled: false destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/SelectiveForwardCallSettingPatch' /telephony/config/workspaces/{workspaceId}/selectiveForward/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceSelectiveForwardCallCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ forwardToPhoneNumber: '+1934898988' sendToVoicemailEnabled: true scheduleName: Business Vacation scheduleType: holidays scheduleLevel: GROUP callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true numbers: - '+19075552859' - '+19186663950' forwardEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Selective Forward Criteria for a Workspace operationId: Retrieve Selective Forward Criteria for a Workspace description: 'Retrieve Selective Forward Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Selective Forward Criteria for a Workspace operationId: Modify Selective Forward Criteria for a Workspace description: 'Modify Selective Forward Call Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: forwardToPhoneNumber: '+1934898988' destinationVoicemailEnabled: true scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true numbers: - '+19064441748' - '+19186663950' forwardEnabled: false schema: $ref: '#/components/schemas/PlaceSelectiveForwardCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Selective Forward Criteria for a Workspace operationId: Delete Selective Forward Criteria for a Workspace description: 'Delete Selective Forward Call criteria Settings for a workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/selectiveForward/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Selective Forward Criteria for a Workspace operationId: Create Selective Forward Criteria for a Workspace description: 'Create Selective Forward Call Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week. This API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings. **NOTE**: This API is only available for professional licensed workspaces.' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: ID of the organization within which the workspace resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: forwardToPhoneNumber: '+1934898988' destinationVoicemailEnabled: true scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: GROUP callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true numbers: - '+19064441748' - '+19186663950' forwardEnabled: true schema: $ref: '#/components/schemas/PlaceSelectiveForwardCallCriteriaPost' /telephony/config/workspaces/{workspaceId}/faxMessage/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceFaxMessageAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace Fax Message Available Phone Numbers operationId: Get Workspace Fax Message Available Phone Numbers description: 'List standard numbers that are available to be assigned as a workspace''s FAX message number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
Only available for workspaces with the professional license entitlement.
' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/workspaces/{workspaceId}/secondary/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceSecondaryAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Workspace Secondary Available Phone Numbers operationId: Get Workspace Secondary Available Phone Numbers description: 'List standard numbers that are available to be assigned as a workspace''s secondary number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.
Only available for workspaces with the professional license entitlement.
' tags: - Workspace Call Settings (2/2) parameters: - name: workspaceId in: path description: Unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ= schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. components: schemas: SequentialRingCriteria: type: object required: - id - scheduleName - source - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. source: $ref: '#/components/schemas/Source' description: If criterias are applicable for calls from any phone number or specific phone number. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. PutMusicOnHoldObject: type: object properties: mohEnabled: type: boolean example: true description: Music on hold is enabled or disabled for the workspace. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. PlaceSelectiveRejectCallCriteriaPost: type: object required: - scheduleName - scheduleType - scheduleLevel - callsFrom - rejectEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective reject is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveRejectCallCallsFromType' description: Indicates whether to apply the selective reject criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. rejectEnabled: type: boolean example: true description: Choose to reject (if `rejectEnabled` = `true`) or not to reject (if `rejectEnabled` = `false`) the calls that fit within these parameters. PlacePriorityAlertCriteriaPatch: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the priority alert is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e. Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. notificationEnabled: type: boolean example: true description: When set to `true` priority alerting criteria is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority. CallBridgePatch: type: object required: - warningToneEnabled properties: warningToneEnabled: type: boolean description: '`true` if the Call Bridge Warning Tone feature is enabled.' SequentialRingCriteriaPost: type: object required: - callsFrom - ringEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. scheduleType: type: string enum: - holidays - businessHours description: "This indicates the type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n" scheduleLevel: type: string enum: - GROUP description: "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n" callsFrom: type: string enum: - SELECT_PHONE_NUMBERS - ANY_PHONE_NUMBER description: "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria apply for any incoming number.\n" anonymousCallersEnabled: type: boolean example: true description: When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. SourceForSelectiveForward: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ALL_NUMBERS` - Criteria applies to all incoming numbers.\n * `SPECIFIC_NUMBERS` - Criteria applies only for specific incoming numbers.\n * `ANY_INTERNAL` - Criteria applies to all internal incoming numbers.\n * `ANY_EXTERNAL` - Criteria applies to all external incoming numbers.\n" PushToTalkInfo: type: object required: - allowAutoAnswer - connectionType - accessType properties: allowAutoAnswer: type: boolean example: true description: Set to `true` to enable the Push-to-Talk feature. When enabled, a workspace receives a Push-to-Talk call and answers the call automatically. connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people/workspaces that are allowed or disallowed to interact using the Push-to-Talk feature. WorkspaceSecondaryAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. SelectiveAcceptCallGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Selective Accept feature is enabled.' criteria: type: array items: $ref: '#/components/schemas/SelectiveAcceptCallCriteria' description: A list of criteria specifying conditions when selective accept is in effect. SimultaneousRingNumber: type: object required: - phoneNumber - answerConfirmationRequiredEnabled properties: phoneNumber: type: string example: '+19075552859' description: Phone number set as the sequential number. answerConfirmationRequiredEnabled: type: boolean example: true description: When set to `true` the called party is required to press 1 on the keypad to receive the call. SelectiveRejectCallSettingPatch: type: object required: - enabled properties: enabled: type: boolean description: if `true`, selective reject is enabled. PriorityAlertPatch: type: object required: - enabled properties: enabled: type: boolean description: '`true` if the Priority Alert feature is enabled.' PlaceSelectiveAcceptCallCriteriaPatch: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective accept is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveAcceptCallCallsFromType' description: Indicates whether to apply the selective accept criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. acceptEnabled: type: boolean example: true description: Choose to accept (if `acceptEnabled` = `true`) or not to accept (if `acceptEnabled` = `false`) the calls that fit within these parameters. PushToTalkAccessType: type: string enum: - ALLOW_MEMBERS - BLOCK_MEMBERS description: " * `ALLOW_MEMBERS` - List of people/workspaces that are allowed to use the Push-to-Talk feature to interact with the workspace being configured.\n * `BLOCK_MEMBERS` - List of people/workspaces that are disallowed to interact using the Push-to-Talk feature with the workspace being configured.\n" PriorityAlertGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Priority Alert feature is enabled.' criteria: type: array items: $ref: '#/components/schemas/PriorityAlertCriteria' description: A list of criteria specifying conditions when priority alert is in effect. WorkspaceAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. VoicemailPut: type: object required: - notifications - transferToNumber properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object properties: enabled: type: boolean example: true description: Unanswered call sending to voicemail is enabled or disabled. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" numberOfRings: type: number example: 3 description: Number of rings before an unanswered call will be sent to voicemail. `numberOfRings` must be between 2 and 20, inclusive. notifications: type: object properties: enabled: type: boolean example: true description: Notifications for voicemails will be sent. destination: type: string example: 2025551212@txt.example.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.att.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object properties: enabled: type: boolean example: true description: Enable or disable voicemail caller transfer to a destination by pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - Internal mailbox storage has the following limitations: Single message limit of 10 minutes and total mailbox limit of 100 minutes.\n * `EXTERNAL` - If `EXTERNAL` is selected, all messages will be sent to the email address entered. Messages will not be accessible via phone, clients, or the end user's calling portal.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. faxMessage: type: object properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails are sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates FAX number. extension: type: string example: '1234' description: Designates Optional FAX extension. WorkspaceCallForwardAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber - owner properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for the PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: $ref: '#/components/schemas/NumberOwnerObject' description: Owner details for the phone number. CallRecordingInfo: type: object required: - enabled - record - recordVoicemailEnabled - notification - repeat - serviceProvider - externalGroup - externalIdentifier - startStopAnnouncement properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object required: - type - enabled properties: type: type: string enum: - None - Beep - Play Announcement description: "Type of pause/resume notification.\n * `None` - No notification sound played when call recording is paused or resumed.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when the notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object required: - interval - enabled properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. serviceProvider: type: string example: WSWYZ25455 description: Name of the service provider providing call recording service. externalGroup: type: string example: WSWYZ25455L31161 description: Group utilized by the service provider providing call recording service. externalIdentifier: type: string example: a34iidrh5o@64941297.int10.bcld.webex.com description: Unique person identifier utilized by the service provider providing call recording service. startStopAnnouncement: type: object required: - internalCallsEnabled - pstnCallsEnabled properties: internalCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. WorkspaceSecondaryAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceSecondaryAvailableNumberObject' description: Array of phone numbers. callRecordingResponse: type: object properties: vendorId: type: string example: 53dc4c87-8408-4882-9570-dca2bcdb9280 description: Vendor id returned if Terms of Service is not accepted. vendorName: type: string example: Dubber description: Vendor name returned if Terms of Service is not accepted. termsOfServiceUrl: type: string example: https://www.dubber.net/terms description: Terms of Service URL returned if Terms of Service is not accepted. NumberOwnerObject: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which the PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. PriorityAlertCriteria: type: object required: - id - source - notificationEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the priority alert is in effect. source: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS description: "If criteria are applicable for calls from any phone number or specific phone number.\n * `ALL_NUMBERS` - Indicates that priority alert criteria apply for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Indicates priority alert criteria only apply to specific incoming numbers.\n" notificationEnabled: type: boolean example: true description: When set to `true` notification is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority. PlaceSelectiveAcceptCallCriteriaPost: type: object required: - scheduleName - scheduleType - scheduleLevel - callsFrom - acceptEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective accept is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveAcceptCallCallsFromType' description: Indicates whether to apply the selective accept criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. acceptEnabled: type: boolean example: true description: Choose to accept (if `acceptEnabled` = `true`) or not to accept (if `acceptEnabled` = `false`) the calls that fit within these parameters. WorkspaceOutgoingPermissionDigitPatternPatchObject: type: object properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. NumberOwnerType: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - AUTO_ATTENDANT - CALL_QUEUE - GROUP_PAGING - HUNT_GROUP - VOICE_MESSAGING - OFFICE_ANYWHERE - CONTACT_CENTER_LINK - CONTACT_CENTER_ADAPTER - ROUTE_LIST - VOICEMAIL_GROUP - COLLABORATE_BRIDGE description: " * `PLACE` - PSTN phone number's owner is a workspace.\n * `PEOPLE` - PSTN phone number's owner is a person.\n * `VIRTUAL_LINE` - PSTN phone number's owner is a Virtual Profile.\n * `AUTO_ATTENDANT` - PSTN phone number's owner is an auto-attendant.\n * `CALL_QUEUE` - PSTN phone number's owner is a call queue.\n * `GROUP_PAGING` - PSTN phone number's owner is a group paging.\n * `HUNT_GROUP` - PSTN phone number's owner is a hunt group.\n * `VOICE_MESSAGING` - PSTN phone number's owner is a voice messaging.\n * `OFFICE_ANYWHERE` - PSTN phone number's owner is a Single Number Reach.\n * `CONTACT_CENTER_LINK` - PSTN phone number's owner is a Contact Center link.\n * `CONTACT_CENTER_ADAPTER` - PSTN phone number's owner is a Contact Center adapter.\n * `ROUTE_LIST` - PSTN phone number's owner is a route list.\n * `VOICEMAIL_GROUP` - PSTN phone number's owner is a voicemail group.\n * `COLLABORATE_BRIDGE` - PSTN phone number's owner is a collaborate bridge.\n" GetMusicOnHoldObject: type: object required: - mohEnabled - mohLocationEnabled - greeting properties: mohEnabled: type: boolean example: true description: Music on hold enabled or disabled for the workspace. mohLocationEnabled: type: boolean example: true description: Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is false and `mohEnabled` is true, music on hold is disabled for the workspace. When `mohLocationEnabled` is true and `mohEnabled` is false, music on hold is turned off for the workspace. In both cases, music on hold will not be played. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileGetObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. SelectiveRejectCallCallsFromType: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - FORWARDED description: " * `ANY_PHONE_NUMBER` - The Schedule applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The Schedule applies to select phone number defined in the `phoneNumbers` property.\n * `FORWARDED` - The Schedule applies to the forwarded calls only.\n" PushToTalkNumberObject: type: object properties: external: type: string example: '+19845551088' description: External phone number of the person. extension: type: string example: '1088' description: Extension number of the person. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341088' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: If `true`, specifies whether the phone number is primary number. CallBridgeGet: type: object required: - warningToneEnabled properties: warningToneEnabled: type: boolean description: '`true` if the Call Bridge Warning Tone feature is enabled.' WorkspaceCallInterceptAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceCallInterceptAvailableNumberObject' description: Array of phone numbers. SequentialRingNumber: type: object required: - answerConfirmationRequiredEnabled - numberOfRings properties: phoneNumber: type: string example: '+442071838750' description: Phone number set as the sequential number. answerConfirmationRequiredEnabled: type: boolean example: true description: When set to `true` the called party is required to press 1 on the keypad to receive the call. numberOfRings: type: number example: 2 description: The number of rings to the specified phone number before the call advances to the subsequent number in the sequence or goes to voicemail. AudioAnnouncementFileGetObject: type: object required: - id - fileName - mediaFileType - level properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" WorkspaceOutgoingPermissionDigitPatternCategoryControlPatchObject: type: object properties: useCustomDigitPatterns: type: boolean example: true description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. WorkspaceFaxMessageAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceFaxMessageAvailableNumberObject' description: Array of phone numbers. CallRecordingPut: type: object properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object properties: type: type: string enum: - Beep - Play Announcement description: "Type of pause/resume notification. If `enabled` is `true` and `type` is not provided then `type` is set to `Beep` by default.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. startStopAnnouncement: type: object properties: internalCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. WorkspaceECBNAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which the phone number is assigned. type: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - HUNT_GROUP description: "Type of the phone number's owner.\n * `PLACE` - Phone number's owner is a workspace.\n * `PEOPLE` - Phone number's owner is a person.\n * `VIRTUAL_LINE` - Phone number's owner is a Virtual Line.\n * `HUNT_GROUP` - Phone number's owner is a Hunt Group.\n" firstName: type: string example: Test description: First name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the phone number's owner. This field will be present only when the owner `type` is `PLACE` or `HUNT_GROUP`. Action: type: string enum: - ADD - DELETE description: " * `ADD` - Add action.\n * `DELETE` - Delete action.\n" SimultaneousRingNumberGet: type: object required: - phoneNumber - answerConfirmationRequiredEnabled properties: phoneNumber: type: string example: '+19075552859' description: Phone number set as the sequential number. answerConfirmationRequiredEnabled: type: boolean example: true description: When set to `true` the called party is required to press 1 on the keypad to receive the call. PlaceSimultaneousRingCriteriaPatch: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply simultaneously ring for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing criteria is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. Source: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS description: " * `ALL_NUMBERS` - Criteria applies to all incoming numbers.\n * `SPECIFIC_NUMBERS` - Criteria applies only for specific incoming numbers.\n" RingPattern: type: string enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT description: " * `NORMAL` - Normal incoming ring pattern.\n * `LONG_LONG` - Incoming ring pattern of two long rings.\n * `SHORT_SHORT_LONG` - Incoming ring pattern of two short rings, followed by a short ring.\n * `SHORT_LONG_SHORT` - Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.\n" PlaceSelectiveAcceptCallCriteriaGet: type: object required: - id - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective accept is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveAcceptCallCallsFromType' description: Indicates whether to apply the selective accept criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables selective accept to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables selective accept to calls if the callers are unavailable. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. acceptEnabled: type: boolean example: true description: Indicates whether the calls, that fit within these parameters, will be accepted (if acceptEnabled = `true`) or not (if acceptEnabled = `false`). ModifyVoicemailPasscode: type: object required: - passcode properties: passcode: type: string example: '1551234' description: Voicemail access passcode. The minimum length of the passcode is 6 and the maximum length is 30. PeopleOrPlaceOrVirtualLineType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: " * `PEOPLE` - Person or list of people.\n * `PLACE` - Workspace that is not assigned to a specific person such as for a shared device in a common area.\n * `VIRTUAL_LINE` - Virtual line or list of virtual lines.\n" PlaceSelectiveRejectCallCriteriaGet: type: object required: - id - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective reject is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveRejectCallCallsFromType' description: Indicates whether to apply the selective reject criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables selective reject to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables selective reject to calls if the callers are unavailable. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. rejectEnabled: type: boolean example: true description: Indicates whether the calls, that fit within these parameters, will be rejected (if rejectEnabled = `true`) or not (if rejectEnabled = `false`). SelectiveAcceptCallSource: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - FORWARDED description: " * `ALL_NUMBERS` - Selective accept criteria applies for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Selective accept criteria applies for calls from specific numbers.\n * `FORWARDED` - Selective accept criteria applies for all forwarded calls.\n" PlaceSimultaneousRingCriteriaGet: type: object required: - id - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply simultaneously ring for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing criteria is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. CallsFromTypeForSelectiveForward: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - The schedule applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The schedule applies to select phone number defined in the `phoneNumbers` property.\n * `ANY_INTERNAL` - The schedule applies to any internal phone number.\n * `ANY_EXTERNAL` - The schedule applies to any external phone number.\n" SelectiveRejectCallGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Selective Reject feature is enabled.' criteria: type: array items: $ref: '#/components/schemas/SelectiveRejectCriteria' description: A list of criteria specifying conditions when selective reject is in effect. PlaceScheduleLevel: type: string enum: - GROUP description: ' * `GROUP` - Indicates the schedule level that specifies that criteria is of Group level. ' SelectiveForwardCallGet: type: object required: - enabled - defaultPhoneNumberToForward - ringReminderEnabled - destinationVoicemailEnabled - criteria properties: enabled: type: boolean example: true description: '`true` if the Selective Forward feature is enabled.' defaultPhoneNumberToForward: type: string example: '+1934898988' description: Enter the phone number to forward calls to during this schedule. ringReminderEnabled: type: boolean example: true description: When `true`, enables a ring reminder for such calls. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. criteria: type: array items: $ref: '#/components/schemas/SelectiveForwardCallCriteria' description: A list of criteria specifying conditions when selective forward feature is in effect. SelectiveRejectCallSource: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - FORWARDED description: " * `ALL_NUMBERS` - Selective reject criteria applies for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Selective reject criteria applies for calls from specific numbers.\n * `FORWARDED` - Selective reject criteria applies for all forwarded calls.\n" PlaceSimultaneousRingCriteriaPost: type: object required: - scheduleName - scheduleType - scheduleLevel - callsFrom - ringEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply simultaneously ring for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing criteria is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. PlacePriorityAlertCriteriaGet: type: object required: - id - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the priority alert is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e. Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. notificationEnabled: type: boolean example: true description: When set to `true` priority alerting criteria is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority. SelectiveAcceptCallSettingPatch: type: object required: - enabled properties: enabled: type: boolean description: indicates whether selective accept is enabled or not. WorkspaceCallInterceptAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber - owner properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for the PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: $ref: '#/components/schemas/NumberOwnerObject' description: Owner details for the phone number. ScheduleTypeSelection: type: string enum: - businessHours - holidays description: " * `businessHours` - The Schedule type that specifies the business or working hours during the day.\n * `holidays` - The Schedule type that specifies the day when your organization is not open.\n" WorkspaceECBNAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceECBNAvailableNumberObject' description: Array of phone numbers. WorkspaceDigitPatternObject: type: object required: - id - name - pattern - action - transferEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 description: A unique identifier for the digit pattern. name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. PlaceSelectiveForwardCallCriteriaPatch: type: object required: - callsFrom properties: forwardToPhoneNumber: type: string example: '+1934898988' description: Phone number to forward calls to during this schedule. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective forward is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromTypeForSelectiveForward' description: Indicates whether to apply the selective forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls if the callers are unavailable. numbers: type: array items: type: string example: +19075552859,+19186663950 description: List of phone numbers checked against incoming calls for a match. forwardEnabled: type: boolean example: true description: Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = `true`) or not (if forwardEnabled = `false`). SequentialRingPatch: type: object properties: enabled: type: boolean example: true description: When set to `true` sequential ring is enabled. ringBaseLocationFirstEnabled: type: boolean example: true description: When set to `true`, the webex calling primary line will ring first. baseLocationNumberOfRings: type: number example: 2 description: The number of times the primary line will ring. `baseLocationNumberOfRings` must be between 2 and 20, inclusive. continueIfBaseLocationIsBusyEnabled: type: boolean example: true description: When set to `true` and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing. callsToVoicemailEnabled: type: boolean example: true description: When set to `true` calls are directed to voicemail. phoneNumbers: type: array items: $ref: '#/components/schemas/SequentialRingNumberPatch' description: A list of up to five phone numbers to which calls will be directed. SimultaneousRingCriteria: type: object required: - id - source - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the simultaneous ring is in effect. source: $ref: '#/components/schemas/Source' description: If criteria are applicable for calls from any phone number or specific phone number. ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. SelectiveAcceptCallCriteria: type: object required: - id - scheduleName - source - acceptEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective reject is in effect. source: $ref: '#/components/schemas/SelectiveAcceptCallSource' description: If criteria are applicable for calls from any phone number, specific phone number or forwarded ones. acceptEnabled: type: boolean example: true description: This setting specifies to choose to accept or not to accept the calls that fit within these parameters. UserCallPoliciesPatch: type: object required: - connectedLineIdPrivacyOnRedirectedCalls properties: connectedLineIdPrivacyOnRedirectedCalls: type: string enum: - NO_PRIVACY - PRIVACY_FOR_EXTERNAL_CALLS - PRIVACY_FOR_ALL_CALLS description: "Specifies the connection type to be used.\n * `NO_PRIVACY` - Connected line identification is not blocked on redirected calls.\n * `PRIVACY_FOR_EXTERNAL_CALLS` - Connected line identification is blocked on redirected calls to external numbers.\n * `PRIVACY_FOR_ALL_CALLS` - Connected line identification is blocked on all redirected calls.\n" PushToTalkPut: type: object properties: allowAutoAnswer: type: boolean example: true description: '`true` if Push-to-Talk feature is enabled.' connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: List of people that are allowed or disallowed to interact using the Push-to-Talk feature. PrivacyGet: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dialing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people that are being monitored. PlaceDoNotDisturbPatch: type: object properties: enabled: type: boolean description: '`true` if the DoNotDisturb feature is enabled.' ringSplashEnabled: type: boolean description: When `true`, enables ring reminder when you receive an incoming call while on Do Not Disturb. UserBargeInPatch: type: object required: - enabled properties: enabled: type: boolean description: '`true` if the Barge In feature is enabled.' toneEnabled: type: boolean description: When `true`, a tone is played when someone barges into a call. PrivacyPatch: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dialing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: type: string description: List of monitoring person IDs. WorkspaceOutgoingPermissionDigitPatternPostObject: type: object required: - name - pattern - action - transferEnabled properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. PlaceDoNotDisturbGet: type: object required: - enabled - ringSplashEnabled properties: enabled: type: boolean example: true description: '`true` if the DoNotDisturb feature is enabled.' ringSplashEnabled: type: boolean description: When `true`, enables ring reminder when you receive an incoming call while on Do Not Disturb. UserNumbersPatch: type: object required: - phoneNumbers properties: distinctiveRingEnabled: type: boolean example: true description: Enables a distinctive ring pattern for the person. phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumber' description: List of phone numbers that are assigned to a person. WorkspaceOutgoingPermissionDigitPatternGetListObject: type: object required: - useCustomDigitPatterns - digitPatterns properties: useCustomDigitPatterns: type: boolean description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. digitPatterns: type: array items: $ref: '#/components/schemas/WorkspaceDigitPatternObject' description: List of digit patterns. SelectiveAcceptCallCallsFromType: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - FORWARDED description: " * `ANY_PHONE_NUMBER` - The Schedule applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The Schedule applies to select phone number defined in the `phoneNumbers` property.\n * `FORWARDED` - The Schedule applies to the forwarded calls only.\n" PlaceSelectiveForwardCallCriteriaPost: type: object required: - callsFrom properties: forwardToPhoneNumber: type: string example: '+1934898988' description: Phone number to forward calls to during this schedule. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective forward is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromTypeForSelectiveForward' description: Indicates whether to apply the selective forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls if the callers are unavailable. numbers: type: array items: type: string example: +19075552859,+19186663950 description: List of phone numbers checked against incoming calls for a match. forwardEnabled: type: boolean example: true description: Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = `true`) or not (if forwardEnabled = `false`). SequentialRingCriteriaGet: type: object required: - id - scheduleName - scheduleType - scheduleLevel - callsFrom - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. scheduleType: type: string enum: - holidays - businessHours description: "The type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n" scheduleLevel: type: string enum: - GROUP description: "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n" callsFrom: type: string enum: - SELECT_PHONE_NUMBERS - ANY_PHONE_NUMBER description: "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria apply for any incoming number.\n" anonymousCallersEnabled: type: boolean example: true description: When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. UserCallPoliciesGet: type: object required: - connectedLineIdPrivacyOnRedirectedCalls properties: connectedLineIdPrivacyOnRedirectedCalls: type: string enum: - NO_PRIVACY - PRIVACY_FOR_EXTERNAL_CALLS - PRIVACY_FOR_ALL_CALLS description: "Specifies the connection type to be used.\n * `NO_PRIVACY` - Connected line identification is not blocked on redirected calls.\n * `PRIVACY_FOR_EXTERNAL_CALLS` - Connected line identification is blocked on redirected calls to external numbers.\n * `PRIVACY_FOR_ALL_CALLS` - Connected line identification is blocked on all redirected calls.\n" PushToTalkConnectionType: type: string enum: - ONE_WAY - TWO_WAY description: " * `ONE_WAY` - Push-to-Talk initiators can chat with this workspace but only in one direction. The workspace you enable Push-to-Talk for cannot respond.\n * `TWO_WAY` - Push-to-Talk initiators can chat with this workspace in a two-way conversation. The workspace you enable Push-to-Talk for can respond.\n" AudioAnnouncementFileObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all four fields are provided, file with given `id` is used and other fields are ignored. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" SelectiveForwardCallCriteria: type: object required: - id - scheduleName - source - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. source: $ref: '#/components/schemas/SourceForSelectiveForward' description: Criteria are applicable for calls from any phone number or a specific phone number. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. PhoneNumber: type: object required: - primary - action - directNumber properties: primary: type: boolean example: true description: If `true` marks the phone number as primary. action: $ref: '#/components/schemas/Action' description: Either 'ADD' to add phone numbers or 'DELETE' to remove phone numbers. directNumber: type: string example: '+12145553567' description: Phone numbers that are assigned. extension: type: string example: '1234' description: Extension that is assigned. ringPattern: $ref: '#/components/schemas/RingPattern' description: Ring Pattern of this number. UserBargeInGet: type: object required: - enabled - toneEnabled properties: enabled: type: boolean example: true description: '`true` if the BargeIn feature is enabled.' toneEnabled: type: boolean description: When `true`, a tone is played when someone barges into a call. AnonymousCallRejectionPatch: type: object required: - enabled properties: enabled: type: boolean description: '`true` if the Anonymous Call Rejection feature is enabled.' PlacePriorityAlertCriteriaPost: type: object required: - scheduleName - scheduleType - scheduleLevel - callsFrom - notificationEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the priority alert is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e. Group. callsFrom: $ref: '#/components/schemas/CallsFromType' description: Indicates whether to apply priority alert for calls from Any Phone Number or Select Phone Numbers. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. notificationEnabled: type: boolean example: true description: When set to `true` priority alerting criteria is enabled for calls that meet the current criteria. Criteria with `notificationEnabled` set to `false` take priority. WorkspaceAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceAvailableNumberObject' description: Array of phone numbers. AnonymousCallRejectionGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Anonymous Call Rejection feature is enabled.' SelectiveForwardCallSettingPatch: type: object properties: enabled: type: boolean example: true description: '`true` if the Selective Forward feature is enabled.' defaultPhoneNumberToForward: type: string example: '+1934898988' description: Enter the phone number to forward calls to during this schedule. ringReminderEnabled: type: boolean example: true description: When `true`, enables a ring reminder for such calls. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. SequentialRingGet: type: object required: - enabled - ringBaseLocationFirstEnabled - baseLocationNumberOfRings - continueIfBaseLocationIsBusyEnabled - callsToVoicemailEnabled - phoneNumbers - criteria properties: enabled: type: boolean example: true description: When set to `true` sequential ring is enabled. ringBaseLocationFirstEnabled: type: boolean example: true description: When set to `true`, the webex calling primary line will ring first. baseLocationNumberOfRings: type: string example: '2' description: The number of times the primary line will ring. continueIfBaseLocationIsBusyEnabled: type: boolean example: true description: When set to `true` and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing. callsToVoicemailEnabled: type: boolean example: true description: When set to `true` calls are directed to voicemail. phoneNumbers: type: array items: $ref: '#/components/schemas/SequentialRingNumber' description: A list of up to five phone numbers to which calls will be directed. criteria: type: array items: $ref: '#/components/schemas/SequentialRingCriteria' description: A list of criteria specifying conditions when sequential ringing is in effect. WorkspaceFaxMessageAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. MonitoredPersonObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: Unique identifier of the person. lastName: type: string example: Little description: Last name of the person. firstName: type: string example: Alice description: First name of the person. displayName: type: string example: Alice Little description: Display name of the person. type: $ref: '#/components/schemas/PeopleOrPlaceOrVirtualLineType' description: Type usually indicates `PEOPLE`, `PLACE` or `VIRTUAL_LINE`. Push-to-Talk and Privacy features only supports `PEOPLE`. email: type: string example: alice@example.com description: Email address of the person. numbers: type: array items: $ref: '#/components/schemas/PushToTalkNumberObject' description: List of phone numbers of the person. STATE: type: string enum: - ACTIVE - INACTIVE description: " * `ACTIVE` - Phone number is in the active state.\n * `INACTIVE` - Phone number is in the inactive state.\n" WorkspaceCallForwardAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WorkspaceCallForwardAvailableNumberObject' description: Array of phone numbers. CallsFromType: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS description: " * `ANY_PHONE_NUMBER` - The Schedule applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - Indicates the schedule applies to select phone number defined in the `phoneNumbers` property.\n" SequentialRingNumberPatch: type: object properties: phoneNumber: type: string example: '+442071838750' description: Phone number set as the sequential number. answerConfirmationRequiredEnabled: type: boolean example: true description: When set to `true` the called party is required to press 1 on the keypad to receive the call. numberOfRings: type: number example: 2 description: The number of rings to the specified phone number before the call advances to the subsequent number in the sequence or goes to voicemail. `numberOfRings` must be between 2 and 20, inclusive. SequentialRingCriteriaPatch: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. scheduleType: type: string enum: - holidays - businessHours description: "This indicates the type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n" scheduleLevel: type: string enum: - GROUP description: "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n" callsFrom: type: string enum: - SELECT_PHONE_NUMBERS - ANY_PHONE_NUMBER description: "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only applies for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria applies for any incoming number.\n" anonymousCallersEnabled: type: boolean example: true description: When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. SimultaneousRingPatch: type: object required: - criteriasEnabled properties: enabled: type: boolean example: true description: Simultaneous Ring is enabled or not. doNotRingIfOnCallEnabled: type: boolean example: true description: When set to `true`, the configured phone numbers won't ring when on a call. phoneNumbers: type: array items: $ref: '#/components/schemas/SimultaneousRingNumber' description: Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call. criteriasEnabled: type: boolean example: true description: When `true`, enables the selected schedule for simultaneous ring. SelectiveRejectCriteria: type: object required: - id - scheduleName - source - rejectEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective reject is in effect. source: $ref: '#/components/schemas/SelectiveRejectCallSource' description: If criteria are applicable for calls from any phone number, specific phone number or forwarded ones. rejectEnabled: type: boolean example: true description: This setting specifies to choose to reject or not to reject the calls that fit within these parameters. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN number. ' PlaceSelectiveRejectCallCriteriaPatch: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective reject is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/SelectiveRejectCallCallsFromType' description: Indicates whether to apply the selective reject criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables calls even if callers are unavailable. phoneNumbers: type: array items: type: string example: +19064441748,+19186663950 description: the list of phone numbers that will checked against incoming calls for a match. rejectEnabled: type: boolean example: true description: Choose to reject (if `rejectEnabled` = `true`) or not to reject (if `rejectEnabled` = `false`) the calls that fit within these parameters. PlaceSelectiveForwardCallCriteriaGet: type: object required: - id - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. forwardToPhoneNumber: type: string example: '+1934898988' description: Phone number to forward calls to during this schedule. sendToVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the selective forward is in effect. scheduleType: $ref: '#/components/schemas/ScheduleTypeSelection' description: The Schedule type whether `businessHours` or `holidays`. scheduleLevel: $ref: '#/components/schemas/PlaceScheduleLevel' description: The Schedule level i.e, Group. callsFrom: $ref: '#/components/schemas/CallsFromTypeForSelectiveForward' description: Indicates whether to apply the selective forward criteria for calls from Any Phone Number, Select Phone Numbers or Forwarded ones. anonymousCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, enables selective forward to calls if the callers are unavailable. numbers: type: array items: type: string example: +19075552859,+19186663950 description: List of phone numbers checked against incoming calls for a match. forwardEnabled: type: boolean example: true description: Indicates whether the calls, that fit within these parameters, will be forwarded (if forwardEnabled = `true`) or not (if forwardEnabled = `false`). VoicemailInfo: type: object required: - enabled - sendAllCalls - sendBusyCalls - sendUnansweredCalls - notifications - transferToNumber - emailCopyOfMessage - messageStorage - faxMessage properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object required: - enabled properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object required: - enabled - greeting - greetingUploaded properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded. description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object required: - enabled - greeting - greetingUploaded - numberOfRings - systemMaxNumberOfRings properties: enabled: type: boolean example: true description: Enables and disables sending unanswered calls to voicemail. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded numberOfRings: type: number example: 3 description: Number of rings before unanswered call will be sent to voicemail. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. notifications: type: object required: - enabled properties: enabled: type: boolean example: true description: Send of unanswered calls to voicemail is enabled or disabled. destination: type: string example: 2025551212@txt.att.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.example.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object required: - enabled properties: enabled: type: boolean example: true description: Enabled or disabled state of giving caller option to transfer to destination when pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object required: - enabled - emailId properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object required: - mwiEnabled - storageType - externalEmail properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - For message access via phone or the Calling User Portal.\n * `EXTERNAL` - For sending all messages to the person's email.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. A value for this field must be provided in the request if a `storageType` of `EXTERNAL` is given in the request. faxMessage: type: object required: - enabled properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails will be sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates phone number for the FAX. A value for this field must be provided in the request if faxMessage `enabled` field is given as `true` in the request. extension: type: string example: '1234' description: Designates optional FAX extension. SimultaneousRingGet: type: object required: - enabled - doNotRingIfOnCallEnabled - criteriasEnabled properties: enabled: type: boolean example: true description: Simultaneous Ring is enabled or not. doNotRingIfOnCallEnabled: type: boolean example: true description: When set to `true`, the configured phone numbers won't ring when on a call. phoneNumbers: type: array items: $ref: '#/components/schemas/SimultaneousRingNumberGet' description: Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call. criteria: type: array items: $ref: '#/components/schemas/SimultaneousRingCriteria' description: A list of criteria specifying conditions when simultaneous ring is in effect. criteriasEnabled: type: boolean example: true description: When `true`, enables the selected schedule for simultaneous ring. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps