openapi: 3.2.0
info:
title: Webex Call Settings For Me Phase 5 API
version: 1.0.0
description: 'Operations tagged Call Settings For Me Phase 5 across 2 of this provider''s published API definitions: webex-call-settings-for-me-phase-5-api-openapi.yml,
webex-cloud-calling-openapi.json. 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: 7/7
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: Call Settings For Me Phase 5
paths:
/telephony/config/people/me/settings/personalAssistant:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalAssistantSettings'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Get Personal Assistant Settings
operationId: getPersonalAssistantSettings
description: 'Retrieve personal assistant settings for a person. The personal assistant feature allows users to configure
an automated attendant that can handle incoming calls when they are unavailable, including presence-based routing
and call transfer options.
Personal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user''s availability
status.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me Phase 5
parameters: []
put:
responses:
'204':
description: 'No Content: Personal assistant settings successfully updated.'
'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: Update Personal Assistant Settings
operationId: updatePersonalAssistantSettings
description: 'Update personal assistant settings for a person. Allows configuring the personal assistant feature including
enabling/disabling it, setting presence status, configuring call transfer options, and alerting preferences.
Personal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user''s availability
status.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me Phase 5
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalAssistantSettingsUpdate'
/telephony/config/people/me/voicemail/rules:
get:
summary: Get Person's Voicemail Rules
operationId: getUserVoicemailRules
description: 'Get person''s voicemail passcode rules. Voicemail rules specify the default passcode requirements. They
are provided for informational purposes only and cannot be modified.
The voicemail feature allows users to manage their voicemail settings as part of Webex Calling. Voicemail rules help
ensure secure access to voice messages by defining passcode complexity requirements.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me Phase 5
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VoicemailRules'
'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.'
/telephony/config/people/me/voicemail/pin:
put:
summary: Update Voicemail PIN
operationId: updateVoicemailPin
description: 'Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply
with the passcode rules defined for the organization.
The voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN. The PIN
is required to retrieve voice messages via phone.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me Phase 5
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VoicemailPin'
responses:
'204':
description: 'No Content: Voicemail PIN successfully updated.'
'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.'
/telephony/config/people/me/settings/hoteling/guest:
get:
summary: Get Hoteling Guest Settings
operationId: getHotelingGuestSettings
description: 'Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as
a guest, associating their extension and configuration with that device for a limited time. This API returns the current
hoteling guest configuration including any active host association details.
Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared
devices.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me Phase 5
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HotelingGuestSettings'
'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.'
put:
summary: Update Hoteling Guest Settings
operationId: updateHotelingGuestSettings
description: 'Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling
as a guest, configuring whether an association will be removed automatically after a specified time period, and associating
with a hoteling host.
Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared
devices.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me Phase 5
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HotelingGuestSettingsUpdate'
responses:
'204':
description: 'No Content: Hoteling guest settings successfully updated.'
'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.'
/telephony/config/people/me/settings/hoteling/availableHosts:
get:
summary: Get Available Hoteling Hosts
operationId: getAvailableHotelingHosts
description: 'Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts
that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by
name or phone number and supports pagination.
Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared
devices.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me Phase 5
parameters:
- name: max
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 2000
default: 2000
description: Limit the maximum number of hosts in the response. Default is 100.
example: 100
- name: start
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
description: Start index for pagination. Default is 0.
example: 0
- name: name
in: query
required: false
schema:
type: string
description: Filter hosts by name (first name or last name). Partial match is supported.
example: John
- name: phoneNumber
in: query
required: false
schema:
type: string
description: Filter hosts by phone number. Partial match is supported.
example: '+14085551234'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AvailableHotelingHosts'
'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.'
components:
schemas:
BlockRepeatedDigits:
type: object
required:
- enabled
- max
properties:
enabled:
type: boolean
example: true
description: If enabled, checks for sequence of the same digit being repeated.
max:
type: integer
minimum: 1
maximum: 6
example: 3
description: Maximum number of repeated digit sequence allowed. The minimum value is 1. The maximum value is 6.
description: Settings to prevent single digits from being repeated in the passcode. For example, with a maximum value
of 3, 111222 is allowed but 112222 is not allowed since it contains a repeated digit sequence longer than 3.
BlockContiguousSequences:
type: object
required:
- enabled
- numberOfAscendingDigits
- numberOfDescendingDigits
properties:
enabled:
type: boolean
example: true
description: If enabled, passcode should not contain a numerical sequence.
numberOfAscendingDigits:
type: integer
minimum: 2
maximum: 5
example: 3
description: 'Specifies the maximum length of an ascending numerical sequence allowed. The minimum value is 2. The
maximum value is 5. Example: If this value is set to 3, then 123856 is allowed, but 123485 is not allowed (since
the ascending sequence 1234 exceeds 3 digits).'
numberOfDescendingDigits:
type: integer
minimum: 2
maximum: 5
example: 3
description: 'Specifies the maximum length of a descending numerical sequence allowed. The minimum value is 2. The
maximum value is 5. Example: If this value is set to 3, then 321856 is allowed, but 432185 is not allowed (since
the descending sequence 4321 exceeds 3 digits).'
description: Settings for not allowing numerical sequence in passcode (for example, 012345 or 987654).
VoicemailPin:
type: object
required:
- passcode
properties:
passcode:
type: string
description: Person voicemail PIN. The PIN must comply with the passcode rules defined for the organization.
example: '27850230'
PersonalAssistantSettingsUpdate:
type: object
required:
- enabled
properties:
enabled:
type: boolean
example: true
description: Enable/Disable the personal assistant feature.
presence:
type: string
enum:
- BUSINESS_TRIP
- GONE_FOR_THE_DAY
- LUNCH
- MEETING
- OUT_OF_OFFICE
- TEMPORARILY_OUT
- TRAINING
- UNAVAILABLE
- VACATION
example: OUT_OF_OFFICE
description: Presence status that triggers the personal assistant.
untilDateTime:
type: string
format: date-time
example: '2026-03-28T14:30:00Z'
description: Date and time until which the personal assistant is active (ISO 8601 format).
transferEnabled:
type: boolean
example: true
description: Enable/Disable call transfer when personal assistant is active.
transferNumber:
type: string
example: '+14126525012'
description: Phone number to transfer calls to when transfer is enabled.
alerting:
type: string
enum:
- ALERT_ME_FIRST
- PLAY_RING_REMINDER
- NONE
example: ALERT_ME_FIRST
description: 'Alerting behavior for incoming calls when personal assistant is active. Possible values: ALERT_ME_FIRST
- Ring the user''s phone first before the personal assistant takes over. PLAY_RING_REMINDER - Play a ring reminder
to the user. NONE - No alerting.'
alertMeFirstNumberOfRings:
type: integer
minimum: 0
maximum: 20
example: 3
description: Number of rings before transferring the call when alerting is set to ALERT_ME_FIRST.
description: Personal assistant settings update request.
example:
enabled: true
presence: OUT_OF_OFFICE
untilDateTime: '2026-03-28T14:30:00Z'
transferEnabled: true
transferNumber: '+14126525012'
alerting: ALERT_ME_FIRST
alertMeFirstNumberOfRings: 3
AvailableHotelingHosts:
type: object
required:
- hosts
properties:
hosts:
type: array
items:
$ref: '#/components/schemas/AvailableHotelingHost'
description: List of available hoteling hosts.
description: List of available hoteling hosts that a person can associate with as a guest.
example:
hosts:
- hostId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA
firstName: John
lastName: Doe
phoneNumber: '+14085551234'
extension: '1234'
allowedAssociationDuration: 24
- hostId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODc2NTQzMi0xMjM0LTU2NzgtOTBhYi1jZGVmMTIzNDU2Nzg
firstName: Jane
lastName: Smith
phoneNumber: '+14085555678'
extension: '5678'
allowedAssociationDuration: 12
Hoteling
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-call-settings-for-me-phase-5-api-openapi.yml