openapi: 3.2.0
info:
title: Webex Workspace Call Settings (1/2) API
version: 1.0.0
description: 'Operations tagged Workspace Call Settings (1/2) across 2 of this provider''s published API definitions: webex-cloud-calling-openapi.json,
webex-workspace-call-settings-1-2-api-openapi.yml. Each path carries the servers of the definition it was published in.'
x-provenance:
method: harvested
authored_by: Cisco Webex
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
provider_published: true
derived_view: Per-tag view of webex-cloud-calling-openapi.json, the provider's source document. Operations and schemas
are the provider's, unmodified; only the partition is ours.
derived_from: webex-cloud-calling-openapi.json
operation_coverage: 21/21
x-evidence:
- type: source
url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-cloud-calling.json
- type: raw
url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-cloud-calling.json
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/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: 'Metho
# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-workspace-call-settings-1-2-api-openapi.yml