openapi: 3.2.0
info:
title: Webex Call Settings For Me With UserHub Phase3 API
version: 1.0.0
description: 'Operations tagged Call Settings For Me With UserHub Phase3 across 2 of this provider''s published API definitions:
webex-call-settings-for-me-with-userhub-phase3-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: Call Settings For Me With UserHub Phase3
paths:
/telephony/config/people/me/settings/selectiveReject:
get:
responses:
'200':
description: Selective Call Reject Settings retrieved for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SelectiveRejectCallSettingsGet'
example:
enabled: true
criteria:
- id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
scheduleName: CustomHoliday(Group)
source: ALL_NUMBERS
rejectEnabled: false
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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 Selective Call Reject Settings for User
operationId: getMySelectiveRejectSettings
description: 'Get Selective Call Reject Settings for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters: []
put:
responses:
'204':
description: Selective Call Reject Settings updated successfully for the authenticated user.
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Modify Selective Call Reject Settings for User
operationId: updateMySelectiveRejectSettings
description: 'Update Selective Call Reject Settings for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters: []
requestBody:
content:
application/json:
example:
enabled: false
schema:
$ref: '#/components/schemas/SelectiveRejectCallSettingPatch'
/telephony/config/people/me/settings/selectiveReject/criteria:
post:
summary: Add User Selective Call Reject Criteria
operationId: createMySelectiveRejectCriteria
description: 'Create a new Selective Call Reject Criteria for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase3
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SelectiveRejectCallCriteriaPost'
example:
scheduleName: Holiday V2
scheduleType: businessHours
scheduleLevel: PEOPLE
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: true
unavailableCallersEnabled: true
phoneNumbers:
- '+19064441748'
- '+19186663950'
rejectEnabled: true
responses:
'200':
description: Selective Call Reject Criteria created successfully. Returns the criteria ID.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseId'
example:
id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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.'
'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.'
'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.'
'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).'
/telephony/config/people/me/settings/anonymousCallReject:
get:
responses:
'200':
description: Anonymous Call Rejection Settings retrieved for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AnonymousCallRejectSettingsGet'
example:
enabled: true
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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 Anonymous Call Rejection Settings for User
operationId: getMyAnonymousCallRejectSettings
description: 'Get Anonymous Call Rejection Settings for the authenticated user.
Anonymous Call Rejection allows you to reject calls from anonymous callers.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters: []
put:
responses:
'204':
description: Anonymous Call Rejection Settings updated successfully for the authenticated user.
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Modify Anonymous Call Rejection Settings for User
operationId: updateMyAnonymousCallRejectSettings
description: 'Update Anonymous Call Rejection Settings for the authenticated user.
Anonymous Call Rejection allows you to reject calls from anonymous callers.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters: []
requestBody:
content:
application/json:
example:
enabled: false
schema:
$ref: '#/components/schemas/AnonymousCallRejectSettingsPatch'
/telephony/config/people/me/settings/selectiveReject/criteria/{id}:
get:
responses:
'200':
description: Selective Call Reject Criteria Settings retrieved for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SelectiveRejectCallCriteriaGet'
example:
id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
scheduleName: CustomHoliday(Group)
scheduleType: holidays
scheduleLevel: PEOPLE
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: false
unavailableCallersEnabled: false
phoneNumbers:
- '+16177817765'
rejectEnabled: false
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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 Selective Call Reject Criteria Settings for User
operationId: getMySelectiveRejectCriteriaSettings
description: 'Get Selective Call Reject Criteria Settings for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the selective call reject criteria. Example:
`Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
put:
responses:
'204':
description: Selective Call Reject Criteria Settings updated successfully for the authenticated user.
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
try to reduce it.'
summary: Modify a Selective Call Reject Criteria
operationId: updateMySelectiveCallRejectCriteriaSettings
description: 'Modify Selective Call Reject Criteria Settings for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the selective call reject. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
requestBody:
content:
application/json:
example:
scheduleName: Holiday V2
scheduleType: holidays
scheduleLevel: LOCATION
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: true
unavailableCallersEnabled: true
rejectEnabled: false
phoneNumbers:
- '+16177817766'
schema:
$ref: '#/components/schemas/SelectiveRejectCallCriteriaPatch'
delete:
summary: Delete a Selective Call Reject Criteria
operationId: deleteMySelectiveCallRejectCriteria
description: 'Delete a Selective Call Reject Criteria for the authenticated user.
Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone
number,identity and the time or day of the call.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the selective call reject criteria. Example:
`Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
responses:
'204':
description: Selective Call Reject Criteria deleted successfully. No content is returned.
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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.'
'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).'
/telephony/config/people/me/settings/callWaiting:
get:
summary: Get Call Waiting Settings for User
operationId: getMyCallWaitingSettings
description: 'Get Call Waiting Settings for the authenticated user.
Call Waiting allows a user to receive multiple calls simultaneously. When the user is on an active call, they can
receive an incoming call and switch between the two calls.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase3
parameters: []
responses:
'200':
description: Call Waiting Settings retrieved for the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/CallWaitingInfo'
example:
enabled: true
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served.'
'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: Modify Call Waiting Settings for User
operationId: updateMyCallWaitingSettings
description: 'Update Call Waiting Settings f
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-call-settings-for-me-with-userhub-phase3-api-openapi.yml