openapi: 3.2.0
info:
title: Webex Beta Call Settings For Me With Userhub Phase1 API
version: 1.0.0
description: 'Operations tagged Beta Call Settings For Me With Userhub Phase1 across 2 of this provider''s published API
definitions: webex-beta-call-settings-for-me-with-userhub-phase1-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: 16/16
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: Beta Call Settings For Me With Userhub Phase1
paths:
/telephony/config/people/me/settings/callPolicies:
get:
responses:
'200':
description: Call policies retrieved successfully for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserCallPoliciesGet'
example:
connectedLineIdPrivacyOnRedirectedCalls: NO_PRIVACY
'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 Call Policies Settings for User
operationId: getMyCallPoliciesSettings
description: 'Get call policies settings for the authenticated user.
Call Policies in Webex allow you to manage how your call information is displayed and handled. You can view privacy
settings for your connected line ID on redirected calls and review other call-related preferences.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
put:
responses:
'204':
description: Call policies updated successfully for the authenticated user.
'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 Policies Settings for User
operationId: updateMyCallPoliciesSettings
description: 'Update call policies settings for the authenticated user.
Call Policies in Webex allow you to manage how your call information is displayed and handled. You can configure privacy
settings for your connected line ID on redirected calls and control other call-related preferences.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
requestBody:
content:
application/json:
example:
connectedLineIdPrivacyOnRedirectedCalls: NO_PRIVACY
schema:
$ref: '#/components/schemas/UserCallPoliciesPut'
/telephony/config/people/me/settings/executive/screening:
get:
responses:
'200':
description: User executive screening settings retrieved successfully.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutiveScreeningGet'
example:
enabled: true
alertType: SILENT
alertAnywhereLocationEnabled: false
alertMobilityLocationEnabled: false
alertSharedCallAppearanceLocationEnabled: false
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Get User Executive Screening Settings
operationId: getMyExecutiveScreeningSettings
description: 'Get executive screening settings for the authenticated user.
Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.
You can enable or disable executive screening and configure alert types and locations for notifications.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
put:
responses:
'204':
description: User executive screening settings modified successfully.
'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 User Executive Screening Settings
operationId: updateMyExecutiveScreeningSettings
description: 'Update executive screening settings for the authenticated user.
Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.
You can enable or disable executive screening and configure alert types and locations for notifications.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
requestBody:
content:
application/json:
example:
enabled: false
alertType: RING_SPLASH
alertAnywhereLocationEnabled: false
alertMobilityLocationEnabled: false
alertSharedCallAppearanceLocationEnabled: false
schema:
$ref: '#/components/schemas/ExecutiveScreeningPut'
/telephony/config/people/me/settings/executive/callFiltering:
get:
responses:
'200':
description: User executive call filtering settings retrieved successfully.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutiveCallFilteringGet'
example:
enabled: true
filterType: CUSTOM_CALL_FILTERS
criteria:
- id: ZmlsdGVyMQ==
filterName: VIP Callers
source: SELECT_PHONE_NUMBERS
activationEnabled: true
filterEnabled: 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: Get User Executive Call Filtering Settings
operationId: getMyExecutiveCallFilteringSettings
description: 'Get executive call filtering settings for the authenticated user.
Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based
on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure
filter rules to manage incoming calls.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
put:
responses:
'204':
description: Executive call filtering settings modified successfully.
'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 User Executive Call Filtering Settings
operationId: updateMyExecutiveCallFilteringSettings
description: 'Update executive call filtering settings for the authenticated user.
Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based
on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure
filter rules to manage incoming calls.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters: []
requestBody:
content:
application/json:
example:
enabled: true
filterType: CUSTOM_CALL_FILTERS
criteriaActivation:
- id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0
activationEnabled: true
schema:
$ref: '#/components/schemas/ExecutiveCallFilteringPatch'
/telephony/config/people/me/settings/executive/callFiltering/criteria/{id}:
get:
responses:
'200':
description: User executive call filtering criteria retrieved successfully.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutiveCallFilteringCriteriaGet'
example:
id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0
filterName: VIP Callers
scheduleName: Business Hours
scheduleType: businessHours
scheduleLevel: PEOPLE
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: false
unavailableCallersEnabled: false
phoneNumbers:
- '+14085551234'
- '+14085551235'
filterEnabled: true
callsToNumbers:
- type: PRIMARY
phoneNumber: '+14085556789'
'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 User Executive Call Filtering Criteria Settings
operationId: getMyExecutiveCallFilteringCriteria
description: 'Get executive call filtering criteria settings for the authenticated user.
Executive Call Filtering Criteria in Webex allows you to retrieve detailed configuration for a specific filter rule.
This includes schedule settings, phone number filters, and call routing preferences for executive call filtering.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0
description: 'The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example:
`Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`.'
put:
responses:
'200':
description: Executive call filtering criteria updated successfully. Returns the updated criteria ID.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseId'
example:
id: Y2lzY29zcGFyazovL3VzL1JFU1VSTkFNRV9IRVJF
'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 User Executive Call Filtering Criteria Settings
operationId: updateMyExecutiveCallFilteringCriteria
description: 'Update executive call filtering criteria settings for the authenticated user.
Executive Call Filtering Criteria in Webex allows you to modify detailed configuration for a specific filter rule.
This includes updating schedule settings, phone number filters, and call routing preferences for executive call filtering.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Beta Call Settings For Me With Userhub Phase1
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0
description: 'The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example:
`Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkR
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-beta-call-settings-for-me-with-userhub-phase1-api-openapi.yml