openapi: 3.0.0 info: title: Webex Admin Address Book Workspace Call Settings (1/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 (1/2) paths: /workspaces/{workspaceId}/features/callForwarding: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceCallForwardingGet' example: callForwarding: always: enabled: false destination: '' ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: true destination: '+17084004987' destinationVoicemailEnabled: true noAnswer: enabled: true destination: '+12815550001' numberOfRings: 2 systemMaxNumberOfRings: 20 destinationVoicemailEnabled: false businessContinuity: enabled: false destination: '' destinationVoicemailEnabled: 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 Forwarding Settings for a Workspace operationId: Retrieve Call Forwarding Settings for a Workspace description: 'Retrieve Call Forwarding Settings for a Workspace. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy, forwards all incoming calls to the destination you chose while the phone is in use or the person is busy. + When no answer, forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. 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.' tags: - Workspace Call Settings (1/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 Forwarding Settings for a Workspace operationId: Modify Call Forwarding Settings for a Workspace description: 'Modify call forwarding settings for a Workspace. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy, forwards all incoming calls to the destination you chose while the phone is in use or the person is busy. + When no answer, forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: callForwarding: always: enabled: false destination: '' ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: true destination: '+17084004987' destinationVoicemailEnabled: true noAnswer: enabled: true destination: '+12815550001' numberOfRings: 2 destinationVoicemailEnabled: false businessContinuity: enabled: false destination: '' destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/ModifyPlaceCallForwardSettings' /workspaces/{workspaceId}/features/callWaiting: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallWaiting' example: enabled: 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 Call Waiting Settings for a Workspace operationId: Retrieve Call Waiting Settings for a Workspace description: 'Retrieve Call Waiting Settings for a Workspace. Call Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call. 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.' tags: - Workspace Call Settings (1/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 Waiting Settings for a Workspace operationId: Modify Call Waiting Settings for a Workspace description: 'Modify Call Waiting Settings for a Workspace. Call Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: callWaiting: true schema: $ref: '#/components/schemas/ModifyCallWaiting' /workspaces/{workspaceId}/features/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceCallerIdGet' example: types: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM selected: DIRECT_LINE directNumber: '+12815550003' locationNumber: '+12815550002' tollFreeLocationNumber: false customNumber: '+12815550003' displayName: Clockmaker's shop 7.1 displayDetail: . blockInForwardCallsEnabled: false externalCallerIdNamePolicy: DIRECT_LINE customExternalCallerIdName: Custom external caller name locationExternalCallerIdName: Anna directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith '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 Caller ID Settings for a Workspace operationId: Read Caller ID Settings for a Workspace description: 'Retrieve a workspace''s Caller ID settings. Caller ID settings control how a workspace''s information is displayed when making outgoing calls. 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.' tags: - Workspace Call Settings (1/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 Caller ID Settings for a Workspace operationId: Configure Caller ID Settings for a Workspace description: 'Configure workspace''s Caller ID settings. Caller ID settings control how a workspace''s information is displayed when making outgoing calls. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: selected: DIRECT_LINE customNumber: '+12815550003' displayName: Clockmaker's shop 7.1 displayDetail: . blockInForwardCallsEnabled: false externalCallerIdNamePolicy: DIRECT_LINE customExternalCallerIdName: Anna directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith schema: $ref: '#/components/schemas/ModifyPlaceCallerIdGet' /workspaces/{workspaceId}/features/monitoring: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserMonitoringGet' example: callParkNotificationEnabled: false monitoredElements: - member: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NzQzNTI1Yi02ZjgxLTQ0NTktYTYxNC0yN2E0ZDIyZTZhYzI lastName: Hughes firstName: Jack displayName: Jack Hughes type: PEOPLE email: jhughes@example.com numbers: - extension: '587' routingPrefix: '1234' esn: '1234587' primary: true location: Richardson locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M2MDliOGE1LTAxNmQtNDAwNy1hN2E0LTJhMThiZmZjY2FmNg - callparkextension: id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vOGI2NzlmMzktMTdmMC00ODY3LTk4MmYtYmEwMWJmYmE3YjQw name: patch postman test extension: '4594' routingPrefix: '1234' esn: '1234587' location: Banglore locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA '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 Monitoring Settings for a Workspace operationId: Retrieve Monitoring Settings for a Workspace description: 'Retrieves Monitoring settings for a Workspace. Allow workspaces to monitor the line status of specified agents, workspaces, or call park extensions. The line status indicates if a monitored agent or a workspace is on a call, or if a call has been parked on the monitored call park extension. 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.' tags: - Workspace Call Settings (1/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 Monitoring Settings for a Workspace operationId: Modify Monitoring Settings for a Workspace description: 'Modify Monitoring settings for a Workspace. Allow workspaces to monitor the line status of specified agents, workspaces, or call park extensions. The line status indicates if a monitored agent or a workspace is on a call, or if a call has been parked on the monitored call park extension. The number of monitored elements is limited to 50. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: enableCallParkNotification: true monitoredElements: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYjhkYjA4YS0wY2JlLTRlZDctOThmMy05ZThlZjBhOGI2N2E - Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZmJjNzlkNzAtMjM5Zi00YjIyLWE2YTAtZjAwNWFmOGNlMjA0 schema: $ref: '#/components/schemas/UserMonitoringPatch' /workspaces/{workspaceId}/features/numbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PlaceGetNumbersResponse' example: distinctiveRingEnabled: true phoneNumbers: - external: '+12055550001' extension: '12211' routingPrefix: '1234' esn: '123412211' primary: true - external: '+12055550002' extension: '122' routingPrefix: '1234' esn: '123412211' primary: false workspace: id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0MjkzOGQ1LTkyNzMtNGJjNi1hYTNhLTA1Njc3MmRiMzE2NQ location: name: MainOffice id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA organization: id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M name: Atlas_Test_CALL-1237 '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: List numbers associated with a specific workspace operationId: List numbers associated with a specific workspace description: 'List the PSTN phone numbers associated with a specific workspace, by ID, within the organization. Also shows the location and organization associated with the workspace. Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read`.' tags: - Workspace Call Settings (1/2) parameters: - name: workspaceId in: path description: List numbers for this workspace. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: orgId in: query description: Workspace is in this organization. Only admin users of another organization (such as partners) can use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /workspaces/{workspaceId}/features/incomingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserInboundPermissionGet' example: useCustomEnabled: false externalTransfer: ALLOW_ALL_EXTERNAL internalCallsEnabled: true collectCallsEnabled: 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 Incoming Permission Settings for a Workspace operationId: Retrieve Incoming Permission Settings for a Workspace description: 'Retrieve Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization''s default to manage different call types. 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.' tags: - Workspace Call Settings (1/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 Incoming Permission Settings for a Workspace operationId: Modify Incoming Permission Settings for a Workspace description: 'Modify Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization''s default to manage different call types. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: useCustomEnabled: true externalTransfer: BLOCK_ALL_EXTERNAL internalCallsEnabled: false collectCallsEnabled: false schema: $ref: '#/components/schemas/UserInboundPermissionPatch' /workspaces/{workspaceId}/features/outgoingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserOutgoingPermissionGet' example: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: TOLL_FREE action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: INTERNATIONAL action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: OPERATOR_ASSISTED action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: CHARGEABLE_DIRECTORY_ASSISTED action: BLOCK transferEnabled: true isCallTypeRestrictionEnabled: true - callType: SPECIAL_SERVICES_I action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: SPECIAL_SERVICES_II action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: PREMIUM_SERVICES_I action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: PREMIUM_SERVICES_II action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: NATIONAL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: 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 Outgoing Permission Settings for a Workspace operationId: Retrieve Outgoing Permission Settings for a Workspace description: 'Retrieve Outgoing Permission settings for a Workspace. Turn on outgoing call settings for this workspace to override the calling settings from the location that are used by default. 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.' tags: - Workspace Call Settings (1/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 Outgoing Permission Settings for a Workspace operationId: Modify Outgoing Permission Settings for a Workspace description: 'Modify Outgoing Permission settings for a Place. Turn on outgoing call settings for this workspace to override the calling settings from the location that are used by default. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true - callType: TOLL_FREE action: ALLOW transferEnabled: true - callType: INTERNATIONAL action: BLOCK transferEnabled: false - callType: OPERATOR_ASSISTED action: ALLOW transferEnabled: true - callType: CHARGEABLE_DIRECTORY_ASSISTED action: BLOCK transferEnabled: true - callType: SPECIAL_SERVICES_I action: ALLOW transferEnabled: true - callType: SPECIAL_SERVICES_II action: ALLOW transferEnabled: true - callType: PREMIUM_SERVICES_I action: BLOCK transferEnabled: false - callType: PREMIUM_SERVICES_II action: BLOCK transferEnabled: false - callType: NATIONAL action: ALLOW transferEnabled: true schema: $ref: '#/components/schemas/UserOutgoingPermissionPatch' /workspaces/{workspaceId}/features/outgoingPermission/accessCodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListGet' example: useCustomAccessCodes: true accessCodes: - code: '4856' description: Marketing's access code level: CUSTOM - code: '3421' description: Finance's access code level: CUSTOM '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 Access Codes for a Workspace operationId: Retrieve Access Codes for a Workspace description: 'Retrieve Access codes for a Workspace. Access codes 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:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.' tags: - Workspace Call Settings (1/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 Access Codes for a Workspace operationId: Modify Access Codes for a Workspace description: 'Modify Access codes for a workspace. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: useCustomAccessCodes: true deleteCodes: - '4856' - '2421' schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListPatch' 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: Create Access Codes for a Workspace operationId: Create Access Codes for a Workspace description: 'Create new Access codes for the given workspace. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: code: '4856' description: Marketing's access code schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeAdd' 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 Access Codes for a Workspace operationId: Delete all Access Codes for a Workspace description: 'Deletes all Access codes for the given workspace. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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 /workspaces/{workspaceId}/features/intercept: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/InterceptGet' example: enabled: true incoming: type: INTERCEPT_ALL voicemailEnabled: true announcements: greeting: DEFAULT newNumber: enabled: true destination: '+12145551003' zeroTransfer: enabled: true destination: '+12145551003' outgoing: type: INTERCEPT_ALL transferEnabled: true destination: '+12145551003' '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 Intercept Settings for a Workspace operationId: Read Call Intercept Settings for a Workspace description: 'Retrieves Workspace''s Call Intercept Settings The intercept feature gracefully takes a workspace''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified workspace are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. 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.' tags: - Workspace Call Settings (1/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 Call Intercept Settings for a Workspace operationId: Configure Call Intercept Settings for a Workspace description: 'Configures a Workspace''s Call Intercept Settings The intercept feature gracefully takes a workspace''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. This API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_write` or a user auth token with `spark:workspaces_read` scope can be used by a person to read their settings.' tags: - Workspace Call Settings (1/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 incoming: type: INTERCEPT_ALL voicemailEnabled: true announcements: greeting: DEFAULT newNumber: enabled: true destination: '+12145551003' zeroTransfer: enabled: true destination: '+12145551003' outgoing: type: INTERCEPT_ALL transferEnabled: true destination: '+12145551003' schema: $ref: '#/components/schemas/InterceptPatch' /workspaces/{workspaceId}/features/outgoingPermission/autoTransferNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TransferNumberGet' example: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' '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 Transfer Numbers Settings for a Workspace operationId: Retrieve Transfer Numbers Settings for a Workspace description: 'Retrieve Transfer Numbers Settings for a Workspace. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. 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.' tags: - Workspace Call Settings (1/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 Transfer Numbers Settings for a Workspace operationId: Modify Transfer Numbers Settings for a Workspace description: 'Modify Transfer Numbers Settings for a place. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. This API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings.' tags: - Workspace Call Settings (1/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: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' schema: $ref: '#/components/schemas/TransferNumberPatch' components: schemas: CallForwardingAlwaysGet: type: object required: - enabled - ringReminderEnabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"Always" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the person's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. ModifyPlaceCallerIdGet: type: object required: - selected properties: selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID shows the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID shows the main number for the location.\n * `CUSTOM` - Outgoing caller ID shows the value from the customNumber field.\n" customNumber: type: string example: '+12815550003' description: Custom number which is shown if CUSTOM is selected. This value must be a number from the workspace's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the workspace's location. displayName: type: string example: Clockmaker's shop 7.1 description: Workspace's caller ID display name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. displayDetail: type: string example: . description: Workspace's caller ID display details. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this workspace's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is `DIRECT_LINE`.\n * `DIRECT_LINE` - Outgoing caller ID shows the caller's direct line name.\n * `LOCATION` - Outgoing caller ID shows the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID shows the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Custom external caller name description: Custom external caller ID name which is shown if external caller ID name policy is `OTHER`. locationExternalCallerIdName: type: string example: Anna description: Location's external caller ID name which is shown if external caller ID name policy is `LOCATION`. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObjectForPut' description: Settings for the direct line caller ID name to be shown for this workspace. dialByName: type: string example: Hakim Smith description: Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. ModifyPlaceCallForwardSettings: type: object required: - callForwarding - businessContinuity properties: callForwarding: $ref: '#/components/schemas/CallForwardingPlaceSettingPatch' description: Call forwarding settings for a Workspace. businessContinuity: $ref: '#/components/schemas/BusinessContinuityPatch' description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem. 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" DirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. Defaults to `DISPLAY_NAME`. customName: type: string example: Hakim Smith description: The custom direct line caller ID name. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. InterceptIncomingPatch: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "Incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are intercepted.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean example: true description: Enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. announcements: $ref: '#/components/schemas/InterceptAnnouncementsPatch' description: Settings related to how incoming calls are handled when the intercept feature is enabled. UserMonitoringPatch: type: object properties: enableCallParkNotification: type: boolean example: true description: Call park notification is enabled or disabled. monitoredElements: type: array maxItems: 50 items: type: string description: Array of ID strings of monitored elements. Maximum 50 elements. PlaceGetNumbersResponse: 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. AuthorizationCode: type: object properties: code: type: string example: '4856' description: Access code. description: type: string example: Marketing's access code description: The description of the access code. InterceptGet: type: object required: - enabled - incoming - outgoing properties: enabled: type: boolean example: true description: '`true` if call intercept is enabled.' incoming: $ref: '#/components/schemas/InterceptIncomingGet' description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: $ref: '#/components/schemas/InterceptOutGoingGet' description: Settings related to how outgoing calls are handled when the intercept feature is enabled. UserPlaceAuthorizationCodeListGet: type: object required: - accessCodes properties: accessCodes: type: array items: $ref: '#/components/schemas/AuthorizationCode' description: The set of activation codes and description. 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. CallingPermission: type: object required: - callType - action - transferEnabled - isCallTypeRestrictionEnabled properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Type of the outgoing call.\n * `INTERNAL_CALL` - Internal call type.\n * `TOLL_FREE` - Toll free call type.\n * `INTERNATIONAL` - International call type.\n * `OPERATOR_ASSISTED` - Operator Assisted call type.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Chargeable Directory Assisted call type.\n * `SPECIAL_SERVICES_I` - Special Services I call type.\n * `SPECIAL_SERVICES_II` - Special Services II call type.\n * `PREMIUM_SERVICES_I` - Premium Services I call type.\n * `PREMIUM_SERVICES_II` - Premium Services II call type.\n * `NATIONAL` - National call type.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Permission for call types.\n * `ALLOW` - The call type is allowed.\n * `BLOCK` - The call type is blocked.\n * `AUTH_CODE` - Access Code action for the specified call type.\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. isCallTypeRestrictionEnabled: type: boolean example: true description: Indicates if the restriction is enforced by the system for the corresponding call type and cannot be changed. For example, certain call types (such as `INTERNATIONAL`) may be permanently blocked and this field will be `true` to reflect that the restriction is system-controlled and not editable. InterceptIncomingGet: type: object required: - type - voicemailEnabled - announcements properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "Incoming calls are intercepted.\n * `INTERCEPT_ALL` - All incoming calls are intercepted.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean description: Enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. announcements: $ref: '#/components/schemas/InterceptAnnouncementsGet' description: Settings related to how incoming calls are handled when the intercept feature is enabled. MonitoredElementUser: type: object required: - id - firstName - lastName - displayName - type - email - numbers - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE description: ID of person or workspace. firstName: type: string example: John description: First name of person or workspace. lastName: type: string example: Brown description: Last name of person or workspace. displayName: type: string example: John Brown description: Display name of person or workspace. type: type: string enum: - PEOPLE - PLACE description: "Type of the person or workspace.\n * `PEOPLE` - Object is a user.\n * `PLACE` - Object is a workspace.\n" email: type: string example: john.brown@gmail.com description: Email of the person or workspace. numbers: type: array items: $ref: '#/components/schemas/UserNumberItem' description: The list of phone numbers containing only the primary number for the monitored person, workspace. location: type: string example: Alaska description: Name of location for call park. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 description: ID of the location for call park. InterceptPatch: type: object properties: enabled: type: boolean example: true description: '`true` if call interception is enabled.' incoming: $ref: '#/components/schemas/InterceptIncomingPatch' description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: $ref: '#/components/schemas/InterceptOutGoingPatch' description: Settings related to how outgoing calls are handled when the intercept feature is enabled. BusinessContinuityPatch: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. CLIDPolicySelection: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: " * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" UserPlaceAuthorizationCodeListPatch: type: object properties: deleteCodes: type: array items: type: string description: Access Codes to delete. CallForwardingNoAnswerGet: type: object required: - enabled - numberOfRings - systemMaxNumberOfRings - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '+19075552859' description: Destination for "No Answer" call forwarding. numberOfRings: type: number example: 2 description: Number of rings before the call will be forwarded if unanswered. systemMaxNumberOfRings: type: number example: 20 description: System-wide maximum number of rings allowed for `numberOfRings` setting. destinationVoicemailEnabled: type: boolean example: true description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. MonitoredElementCallParkExtension: type: object required: - id - name - extension - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE description: ID of call park extension. name: type: string example: CPE1 description: Name of call park extension. extension: type: string example: '8080' description: Extension of call park extension. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12348080' description: Routing prefix + extension of a person or workspace. location: type: string example: Alaska description: Name of location for call park extension. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 description: ID of location for call park extension. TransferNumberPatch: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1201203650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1201203651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1201203652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. InterceptOutGoingGet: type: object required: - type - transferEnabled properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "All outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are intercepted.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '`+12225551212' description: Number to which the outbound call be transferred. InterceptNumberGet: type: object required: - enabled properties: enabled: type: boolean example: true description: If `true`, the caller hears this new number when the call is intercepted. destination: type: string example: '+12225551212' description: New number the caller hears announced. UserInboundPermissionGet: type: object required: - useCustomEnabled - externalTransfer - internalCallsEnabled - collectCallsEnabled properties: useCustomEnabled: type: boolean example: true description: Incoming Permission state. If disabled, the default settings are used. externalTransfer: type: string enum: - ALLOW_ALL_EXTERNAL - ALLOW_ONLY_TRANSFERRED_EXTERNAL - BLOCK_ALL_EXTERNAL description: "Call transfer setting.\n * `ALLOW_ALL_EXTERNAL` - All external calls are allowed.\n * `ALLOW_ONLY_TRANSFERRED_EXTERNAL` - Only externally transferred external calls are allowed.\n * `BLOCK_ALL_EXTERNAL` - All external calls are blocked.\n" internalCallsEnabled: type: boolean example: true description: Flag to indicate if workspace can receive internal calls. collectCallsEnabled: type: boolean example: true description: Flag to indicate if workspace can receive collect calls. InterceptAnnouncementsGet: type: object required: - greeting - newNumber - zeroTransfer properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "System default message places when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting is played when incoming calls are intercepted.\n" filename: type: string example: incoming.wav description: Filename of the custom greeting; this is an empty string if no custom greeting has been uploaded. newNumber: $ref: '#/components/schemas/InterceptNumberGet' description: Information about the new number announcement. zeroTransfer: $ref: '#/components/schemas/InterceptNumberGet' description: Information about how the call is handled if zero (0) is pressed. ModifyCallForwardingNoAnswer: type: object properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '+19075552859' description: Destination for "No Answer" call forwarding. If enabled true, destination is required. numberOfRings: type: number example: 2 description: Number of rings before the call will be forwarded if unanswered. `numberOfRings` must be between 2 and 20, inclusive. systemMaxNumberOfRings: type: number example: 20 description: Max number of rings before the call will be forwarded if unanswered. destinationVoicemailEnabled: type: boolean example: true description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. CallForwardingPlaceSettingGet: type: object required: - always - busy - noAnswer properties: always: $ref: '#/components/schemas/CallForwardingAlwaysGet' description: Settings for forwarding all incoming calls to the destination you choose. busy: $ref: '#/components/schemas/CallForwardingBusyGet' description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the workspace is busy. noAnswer: $ref: '#/components/schemas/CallForwardingNoAnswerGet' description: Settings for forwarding which only occurs when you are away or not answering your phone. BusinessContinuityGet: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. MonitoredElementItem: type: object properties: callparkextension: $ref: '#/components/schemas/MonitoredElementCallParkExtension' description: Monitored Call Park extension. member: $ref: '#/components/schemas/MonitoredElementUser' description: Monitored member for this workspace. UserNumberItem: type: object required: - primary properties: external: type: string example: '+19075552859' description: Phone number of person or workspace. Either `phoneNumber` or `extension` is mandatory. extension: type: string example: '8080' description: Extension of person or workspace. Either `phoneNumber` or `extension` is mandatory. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12348080' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: Flag to indicate primary phone. tollFreeNumber: type: boolean example: true description: Flag to indicate toll free number. ModifyCallingPermission: type: object properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Types for outgoing calls.\n * `INTERNAL_CALL` - Internal call type.\n * `TOLL_FREE` - Toll Free call type.\n * `INTERNATIONAL` - International call type.\n * `OPERATOR_ASSISTED` - Operator Assisted call type.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Chargeable Directory assisted call type.\n * `SPECIAL_SERVICES_I` - Special Services I call type.\n * `SPECIAL_SERVICES_II` - Special Services II call type.\n * `PREMIUM_SERVICES_I` - Premium Services I call type.\n * `PREMIUM_SERVICES_II` - Premium Services II call type.\n * `NATIONAL` - National call type.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Permission for call types.\n * `ALLOW` - The call type is allowed.\n * `BLOCK` - The call type is blocked.\n * `AUTH_CODE` - Access Code action for the specified call type.\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. InterceptOutGoingPatch: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "All outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are intercepted.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '+12225551212' description: Number to which the outbound call be transferred. SelectionObject: type: string enum: - CUSTOM_NAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this workspace.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this workspace." Action: type: string enum: - ADD - DELETE description: " * `ADD` - Add action.\n * `DELETE` - Delete action.\n" UserOutgoingPermissionGet: type: object required: - useCustomPermissions - callingPermissions properties: useCustomEnabled: type: boolean example: true description: When `true`, indicates that this workspace uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When `true`, indicates that this workspace uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: $ref: '#/components/schemas/CallingPermission' description: Workspace's list of outgoing permissions. TransferNumberGet: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1205553650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1205553651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1205553652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. UserInboundPermissionPatch: type: object properties: useCustomEnabled: type: boolean example: true description: Incoming Permission state. If disabled, the default settings are used. externalTransfer: type: string enum: - ALLOW_ALL_EXTERNAL - ALLOW_ONLY_TRANSFERRED_EXTERNAL - BLOCK_ALL_EXTERNAL description: "Call transfer setting.\n * `ALLOW_ALL_EXTERNAL` - All external calls are allowed.\n * `ALLOW_ONLY_TRANSFERRED_EXTERNAL` - Only externally transferred external calls are allowed.\n * `BLOCK_ALL_EXTERNAL` - All external calls are blocked.\n" internalCallsEnabled: type: boolean example: true description: Flag to indicate if the workspace can receive internal calls. collectCallsEnabled: type: boolean example: true description: Flag to indicate if the workspace can receive collect calls. InterceptAnnouncementsPatch: type: object properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "System default message is placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting is played when incoming calls are intercepted.\n" newNumber: $ref: '#/components/schemas/InterceptNumberPatch' description: Information about the new number announcement. zeroTransfer: $ref: '#/components/schemas/InterceptNumberPatch' description: Information about how the call is handled if zero (0) is pressed. CallForwardingPlaceSettingPatch: type: object required: - always properties: always: $ref: '#/components/schemas/CallForwardingAlwaysGet' description: Settings for forwarding all incoming calls to the destination you choose. busy: $ref: '#/components/schemas/CallForwardingBusyGet' description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the workspace is busy. noAnswer: $ref: '#/components/schemas/ModifyCallForwardingNoAnswer' description: Settings for forwarding which only occurs when you are away or not answering your phone. UserMonitoringGet: type: object required: - callParkNotificationEnabled properties: callParkNotificationEnabled: type: boolean example: true description: Call park notification enabled or disabled. monitoredElements: $ref: '#/components/schemas/MonitoredElementItem' description: Monitored element items. CallWaiting: type: object required: - enabled properties: enabled: type: boolean example: true description: Call Waiting state. UserOutgoingPermissionPatch: type: object properties: useCustomEnabled: type: boolean example: true description: When `true`, indicates that this workspace uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When `true`, indicates that this workspace uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: $ref: '#/components/schemas/ModifyCallingPermission' description: Workspace's list of outgoing permissions. InterceptNumberPatch: type: object properties: enabled: type: boolean example: true description: If `true`, the caller hears this new number when the call is intercepted. destination: type: string example: '+12225551212' description: New number the caller hears announced. DirectLineCallerIdNameObjectForPut: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. customName: type: string example: Hakim Smith description: Sets or clears the custom direct line caller ID name. To clear the `customName`, the attribute must be set to null or empty string. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. PlaceCallForwardingGet: type: object required: - callForwarding - businessContinuity properties: callForwarding: $ref: '#/components/schemas/CallForwardingPlaceSettingGet' description: Call forwarding settings for a Workspace. businessContinuity: $ref: '#/components/schemas/BusinessContinuityGet' description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem. CallForwardingBusyGet: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean description: '"Busy" call forwarding is enabled or disabled.' destination: type: string example: '+19075552859' description: Destination for "Busy" call forwarding. destinationVoicemailEnabled: type: boolean description: Enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. UserPlaceAuthorizationCodeAdd: type: object required: - code - description properties: code: type: string example: '4856' description: An Access code. description: type: string example: Marketing's access code description: The description of the access code. ModifyCallWaiting: type: object properties: enabled: type: boolean example: true description: Call Waiting state. PlaceCallerIdGet: type: object required: - types - selected - directNumber - locationNumber - tollFreeLocationNumber - displayName - displayDetail - blockInForwardCallsEnabled - externalCallerIdNamePolicy - locationExternalCallerIdName properties: types: type: array items: $ref: '#/components/schemas/CLIDPolicySelection' description: Allowed types for the `selected` field. This field is read-only and cannot be modified. selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID shows the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID shows the main number for the location.\n * `CUSTOM` - Outgoing caller ID shows the value from the customNumber field.\n" directNumber: type: string example: '+12815550003' description: Direct number which is shown if `DIRECT_LINE` is selected. locationNumber: type: string example: '+12815550002' description: Location number which is shown if `LOCATION_NUMBER` is selected tollFreeLocationNumber: type: boolean description: Flag to indicate if the location number is toll-free number. customNumber: type: string example: '+12815550003' description: Custom number which is shown if CUSTOM is selected. This value must be a number from the workspace's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the workspace's location. displayName: type: string example: Clockmaker's shop 7.1 description: Workspace's caller ID display name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. displayDetail: type: string example: . description: Workspace's caller ID display details. Default is `.`. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this workspace's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is `DIRECT_LINE`.\n * `DIRECT_LINE` - Outgoing caller ID shows the caller's direct line name.\n * `LOCATION` - Outgoing caller ID shows the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID shows the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Custom external caller name description: Custom external caller ID name which is shown if external caller ID name policy is `OTHER`. locationExternalCallerIdName: type: string example: Anna description: Location's external caller ID name which is shown if external caller ID name policy is `LOCATION`. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this workspace. dialByName: type: string example: Hakim Smith description: The name to be used for dial by name functions. 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