openapi: 3.0.0
info:
title: Webex Admin Address Book Call Settings For Me With UserHub Phase2 API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Call Settings For Me With UserHub Phase2
paths:
/telephony/config/people/me/settings/priorityAlert:
get:
responses:
'200':
description: Priority Alert Settings retrieved successfully for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PriorityAlertGet'
example:
enabled: false
criteria:
- id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
scheduleName: CustomHoliday(Group)
source: ALL_NUMBERS
notificationEnabled: 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 Priority Alert Settings
operationId: getMyPriorityAlertSettings
description: 'Get Priority Alert Settings for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters: []
put:
responses:
'204':
description: Priority Alert 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 Priority Alert Settings for User
operationId: updateMyPriorityAlertSettings
description: 'Update Priority Alert Settings for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters: []
requestBody:
content:
application/json:
example:
enabled: false
schema:
$ref: '#/components/schemas/PriorityAlertPatch'
/telephony/config/people/me/settings/priorityAlert/criteria:
post:
summary: Add a Priority Alert Criteria
operationId: createMyPriorityAlertCriteria
description: 'Create a Priority Alert Criteria for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase2
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PriorityAlertCriteriaPatch'
example:
scheduleName: Holiday V2
scheduleType: businessHours
scheduleLevel: PEOPLE
callsFrom: ANY_PHONE_NUMBER
anonymousCallersEnabled: true
unavailableCallersEnabled: false
notificationEnabled: true
responses:
'200':
description: Priority Alert 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/priorityAlert/criteria/{id}:
get:
responses:
'200':
description: Call Priority Alert Criteria Settings retrieved for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PriorityAlertCriteriaGet'
example:
id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
scheduleName: CustomHoliday(Group)
scheduleType: holidays
scheduleLevel: PEOPLE
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: false
unavailableCallersEnabled: false
phoneNumbers:
- '+16177817765'
notificationEnabled: 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 Priority Alert Criteria Settings
operationId: getMyPriorityAlertCriteriaSettings
description: 'Get Priority Alert Criteria Settings for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
put:
responses:
'204':
description: Priority Alert 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 Settings for a Priority Alert Criteria
operationId: updateMyPriorityAlertCriteriaSettings
description: 'Modify Priority Alert Criteria Settings for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
requestBody:
content:
application/json:
example:
scheduleName: Holiday V2
scheduleType: holidays
scheduleLevel: LOCATION
callsFrom: SELECT_PHONE_NUMBERS
anonymousCallersEnabled: true
unavailableCallersEnabled: true
notificationEnabled: false
phoneNumbers:
- '+16177817766'
schema:
$ref: '#/components/schemas/PriorityAlertCriteriaPatch'
delete:
summary: Delete a Priority Alert Criteria
operationId: deleteMyPriorityAlertCriteria
description: 'Delete a Priority Alert criteria for the authenticated user.
Priority alert allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters:
- name: id
in: path
required: true
schema:
type: string
example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY
description: 'The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.'
responses:
'204':
description: Priority Alert 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/schedules:
get:
responses:
'200':
description: Schedules retrieved successfully for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserScheduleListGetResponse'
example:
schedules:
- id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVTJOb1pXUjFiR1V4
name: Schedule1
type: businessHours
level: PEOPLE
- id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVkdWaGJTQkliMnhwWkdGNQ
name: Team Holiday
type: holidays
level: LOCATION
'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 User (and Location) Schedules
operationId: getMySchedules
description: 'Get Schedules for Call Settings for the authenticated user.
Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.
This API requires a user auth token with a scope of `spark:telephony_config_read`.'
tags:
- Call Settings For Me With UserHub Phase2
parameters: []
post:
summary: Add a User level Schedule for Call Settings
operationId: createMySchedule
description: 'Create a new Schedule for the authenticated user.
Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.
This API requires a user auth token with a scope of `spark:telephony_config_write`.'
tags:
- Call Settings For Me With UserHub Phase2
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserSchedulePostRequest'
example:
name: Holiday V2
type: businessHours
events:
- name: Day_Shift
startDate: '2020-03-18'
endDate: '2020-03-18'
startTime: 08:00
endTime: '17:00'
allDayEnabled: false
recurrence:
recurForEver: true
recurEndDate: '2020-03-18'
recurEndOccurrence: 1
recurDaily:
recurInterval: 1
recurWeekly:
recurInterval: 1
sunday: false
monday: false
tuesday: false
wednesday: true
thursday: false
friday: false
saturday: false
responses:
'200':
description: Schedule created successfully. Returns the Schedule ID.
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseId'
example:
id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc
'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/schedules/{scheduleType}/{scheduleId}:
get:
responses:
'200':
description: Schedule retrieved successfully for the authenticated user.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserScheduleGetResponse'
example:
id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVTJOb1pXUjFiR1V4
type: businessHours
name: Schedule1
events:
- id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG
name: EVENT NAME
startDate: '2023-02-06'
endDate: '2023-02-06'
allDayEnabled: true
recurrence:
recurForEver: true
recurDaily:
recurInterval: 1
- id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUm5KcFpHRjVJREk9
name: Friday 2
startDate: '2020-10-30'
endDate: '2020-10-30'
startTime: '13:00'
endTime: '17:00'
allDayEnabled: false
recurrence:
recurForEver: true
recurWeekly:
sunday: false
monday: false
tuesday: false
wednesday: false
thursday: false
friday: true
saturday: 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 User Schedule
operationId: getMySchedule
description: 'Get a Schedule details for Call Settings of the authenticated user.
Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users t
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-call-settings-for-me-with-userhub-phase2-api-openapi.yml