openapi: 3.0.0 info: title: Webex Admin Address Book Call Settings For Me With UserHub Phase3 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 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 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_write`.' tags: - Call Settings For Me With UserHub Phase3 parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CallWaitingPut' example: enabled: false responses: '204': description: Call Waiting 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.' /telephony/config/people/me/settings/sequentialRing: get: summary: Get Sequential Ring Settings for User operationId: getMySequentialRingSettings description: 'Get Sequential Ring Settings for the authenticated user. Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns. 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: Sequential Ring Settings retrieved for the authenticated user. content: application/json: schema: $ref: '#/components/schemas/SequentialRingSettingsGet' example: enabled: true ringBaseLocationFirstEnabled: false baseLocationNumberOfRings: 3 continueIfBaseLocationIsBusyEnabled: true callsToVoicemailEnabled: false phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationRequiredEnabled: false numberOfRings: 3 criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY scheduleName: BusinessHours source: ALL_NUMBERS ringEnabled: 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 Sequential Ring Settings for User operationId: updateMySequentialRingSettings description: 'Update Sequential Ring Settings for the authenticated user. Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns. 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: required: true content: application/json: schema: $ref: '#/components/schemas/SequentialRingSettingsPut' example: enabled: false ringBaseLocationFirstEnabled: true baseLocationNumberOfRings: 2 continueIfBaseLocationIsBusyEnabled: false callsToVoicemailEnabled: false phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationRequiredEnabled: true numberOfRings: 4 responses: '204': description: Sequential Ring 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.' /telephony/config/people/me/settings/sequentialRing/criteria: post: summary: Add User Sequential Ring Criteria operationId: createMySequentialRingCriteria description: 'Create a new Sequential Ring Criteria for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. 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/SequentialRingCriteriaPost' example: scheduleName: BusinessHours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' ringEnabled: true responses: '200': description: Sequential Ring 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/sequentialRing/criteria/{id}: get: summary: Get Sequential Ring Criteria Settings for User operationId: getMySequentialRingCriteriaSettings description: 'Get Sequential Ring Criteria Settings for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. 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 sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.' responses: '200': description: Sequential Ring Criteria Settings retrieved for the authenticated user. content: application/json: schema: $ref: '#/components/schemas/SequentialRingCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY scheduleName: BusinessHours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+16177817765' ringEnabled: 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 Sequential Ring Criteria Settings for User operationId: updateMySequentialRingCriteriaSettings description: 'Update Sequential Ring Criteria Settings for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. 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 sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SequentialRingCriteriaPut' example: scheduleName: Holidays scheduleType: holidays scheduleLevel: LOCATION callsFrom: ANY_PHONE_NUMBER ringEnabled: false responses: '204': description: Sequential Ring 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.' delete: summary: Delete Sequential Ring Criteria operationId: deleteMySequentialRingCriteria description: 'Delete a Sequential Ring Criteria for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. 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 sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`.' responses: '204': description: Sequential Ring 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).' components: schemas: SequentialRingCriteriaSummary: type: object required: - id - scheduleName - source - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: BusinessHours description: Name of the schedule which determines when sequential ring is in effect. source: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS example: ALL_NUMBERS description: "Type of the source.\n * `ALL_NUMBERS` - sequential ring applies to calls from any phone number.\n * `SPECIFIC_NUMBERS` - sequential ring applies to calls from specific phone numbers.\n" ringEnabled: type: boolean example: true description: Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. If `false`, this criteria acts as a 'Don't Ring' rule. Criteria with ringEnabled set to false have precedence over criteria with ringEnabled set to true. SequentialRingSettingsPut: type: object required: - enabled properties: enabled: type: boolean example: false description: Enable or disable sequential ring for the user. ringBaseLocationFirstEnabled: type: boolean example: true description: When `true`, the user's own devices ring before sequential ring numbers. baseLocationNumberOfRings: type: integer example: 2 description: 'Number of rings for the user''s own devices. Minimum: 2, Maximum: 20.' continueIfBaseLocationIsBusyEnabled: type: boolean example: false description: When `true`, sequential ring continues even when the user is unavailable. It controls if we allow trying the sequential ring numbers when either a service for the user such as Do Not Disturb or Call Waiting sends the call to busy processing, or ringBaseLocationFirstEnabled is true but all the user's devices are unreachable. callsToVoicemailEnabled: type: boolean example: true description: 'When `true`, the caller is provided the option to press the # key to end the sequential ring service and send the call to no answer handling such as voicemail.' phoneNumbers: type: array items: $ref: '#/components/schemas/SequentialRingNumber' description: List of phone numbers to ring sequentially. Maximum 5 phone numbers. SequentialRingSettingsGet: type: object required: - enabled example: enabled: true ringBaseLocationFirstEnabled: false baseLocationNumberOfRings: 3 continueIfBaseLocationIsBusyEnabled: true callsToVoicemailEnabled: false phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationRequiredEnabled: false numberOfRings: 3 criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY scheduleName: BusinessHours source: ALL_NUMBERS ringEnabled: true properties: enabled: type: boolean example: true description: '`true` if the sequential ring feature is enabled.' ringBaseLocationFirstEnabled: type: boolean example: false description: When `true`, the user's own devices ring before sequential ring numbers. baseLocationNumberOfRings: type: integer example: 3 description: 'Number of rings for the user''s own devices. Minimum: 2, Maximum: 20.' continueIfBaseLocationIsBusyEnabled: type: boolean example: true description: When `true`, sequential ring continues even when the user is unavailable. It controls if we allow trying the sequential ring numbers when either a service for the user such as Do Not Disturb or Call Waiting sends the call to busy processing, or ringBaseLocationFirstEnabled is true but all the user's devices are unreachable. callsToVoicemailEnabled: type: boolean example: true description: 'When `true`, the caller is provided the option to press the # key to end the sequential ring service and send the call to no answer handling such as voicemail.' phoneNumbers: type: array items: $ref: '#/components/schemas/SequentialRingNumber' description: List of phone numbers to ring sequentially. criteria: type: array items: $ref: '#/components/schemas/SequentialRingCriteriaSummary' description: List of criteria specifying conditions when sequential ring is in effect. AnonymousCallRejectSettingsPatch: type: object required: - enabled properties: enabled: type: boolean example: false description: Indicates whether Anonymous Call Rejection is enabled or not. SequentialRingCriteriaGet: type: object required: - id - scheduleName - scheduleType - scheduleLevel - callsFrom - ringEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. scheduleType: type: string enum: - holidays - businessHours description: "The type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n" scheduleLevel: type: string enum: - GROUP description: "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n" callsFrom: type: string enum: - SELECT_PHONE_NUMBERS - ANY_PHONE_NUMBER description: "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria apply for any incoming number.\n" anonymousCallersEnabled: type: boolean example: true description: When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. CallWaitingInfo: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Call Waiting feature is enabled.' SequentialRingCriteriaPost: type: object required: - callsFrom - ringEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the location's schedule which determines when the sequential ring is in effect. scheduleType: type: string enum: - holidays - businessHours description: "This indicates the type of schedule.\n * `holidays` - The Schedule is of type `holidays`.\n * `businessHours` - The Schedule is of type `businessHours`.\n" scheduleLevel: type: string enum: - GROUP description: "This indicates the level of the schedule specified by `scheduleName`.\n * `GROUP` - The Schedule specified is of `GROUP` level.\n" callsFrom: type: string enum: - SELECT_PHONE_NUMBERS - ANY_PHONE_NUMBER description: "This indicates if criteria are applicable for calls from any phone number or selected phone numbers.\n * `SELECT_PHONE_NUMBERS` - Sequential ring criteria only apply for selected incoming numbers.\n * `ANY_PHONE_NUMBER` - Sequential ring criteria apply for any incoming number.\n" anonymousCallersEnabled: type: boolean example: true description: When `true` incoming calls from private numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true` incoming calls from unavailable numbers are allowed. This is only applicable when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: +19075552859,+19186663950 description: When callsFrom is set to `SELECT_PHONE_NUMBERS`, indicates a list of incoming phone numbers for which the criteria apply. ringEnabled: type: boolean example: true description: When set to `true` sequential ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. CallWaitingPut: type: object required: - enabled properties: enabled: type: boolean example: false description: Enable or disable Call Waiting for the user. example: enabled: false SequentialRingNumber: type: object required: - answerConfirmationRequiredEnabled - numberOfRings properties: phoneNumber: type: string example: '+442071838750' description: Phone number set as the sequential number. answerConfirmationRequiredEnabled: type: boolean example: true description: When set to `true` the called party is required to press 1 on the keypad to receive the call. numberOfRings: type: number example: 2 description: The number of rings to the specified phone number before the call advances to the subsequent number in the sequence or goes to voicemail. CallsFrom: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - FORWARDED description: " * `ANY_PHONE_NUMBER` - Criteria apply for any incoming number.\n * `SELECT_PHONE_NUMBERS` - Criteria only apply for selected incoming numbers.\n * `FORWARDED` - Criteria only apply for forwarded incoming numbers.\n" SelectiveRejectCallCriteriaPost: type: object required: - callsFrom - rejectEnabled properties: scheduleName: type: string example: CFS-Criteria-F-2 description: Name of the schedule to which the criteria is created. scheduleType: $ref: '#/components/schemas/ScheduleType' description: The schedule type. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFrom' description: Reject calls selection. anonymousCallersEnabled: type: boolean description: Boolean flag indicating if calls from custom numbers, private numbers are enabled. unavailableCallersEnabled: type: boolean description: Boolean flag indicating if calls from custom numbers, unavailable numbers are enabled. phoneNumbers: type: array items: type: string example: '["+1986751234","+1986751234"]' description: List of phone numbers. It does not include extensions. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update. rejectEnabled: type: boolean example: true description: Boolean flag to enable/disable rejection. SelectiveRejectCallCriteriaGet: type: object required: - callsFrom - rejectEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI description: Criteria ID. scheduleName: type: string example: CFS-Criteria-F-2 description: Name of the schedule to which the criteria is created. scheduleType: $ref: '#/components/schemas/ScheduleType' description: The schedule type. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: The schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFrom' description: Reject calls selection. anonymousCallersEnabled: type: boolean description: Boolean flag indicating if calls from custom numbers, private numbers are enabled. unavailableCallersEnabled: type: boolean description: Boolean flag indicating if calls from custom numbers, unavailable numbers are enabled. phoneNumbers: type: array items: type: string example: '["+1986751234","+1986751234"]' description: List of phone numbers. It does not include extensions. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update. rejectEnabled: type: boolean example: true description: Boolean flag to enable/disable rejection. SelectiveRejectCallSettingPatch: type: object required: - enabled properties: enabled: type: boolean description: if `true`, selective reject is enabled. ScheduleType: type: string enum: - businessHours - holidays description: " * `businessHours` - The schedule type that specifies the business or working hours during the day.\n * `holidays` - The schedule type that specifies the day when your organization is not open.\n" SelectiveRejectCallCriteriaPatch: type: object required: - callsFrom - rejectEnabled properties: scheduleName: type: string example: CFS-Criteria-F-2 description: Name of the schedule to which the criteria is created. scheduleType: $ref: '#/components/schemas/ScheduleType' description: schedule type. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFrom' description: Reject calls selection. anonymousCallersEnabled: type: boolean example: true description: Boolean flag indicating if calls from custom numbers, private numbers are enabled. unavailableCallersEnabled: type: boolean example: true description: Boolean flag indicating if calls from custom numbers, unavailable numbers are enabled. phoneNumbers: type: array items: type: string example: '["+1986751234","+1986751234"]' description: List of phone numbers. It does not include extensions. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update. rejectEnabled: type: boolean example: true description: Boolean flag to enable/disable rejection. SelectiveRejectCallSettingsGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the selective reject feature is enabled.' criteria: type: array items: $ref: '#/components/schemas/SelectiveRejectCallCriteria' description: A list of criteria specifying conditions when selective reject is in effect. example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY scheduleName: CustomHoliday(Group) source: ALL_NUMBERS rejectEnabled: true AnonymousCallRejectSettingsGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Anonymous Call Rejection feature is enabled.' example: enabled: true SelectiveRejectCallCriteria: type: object required: - id - scheduleName - source - rejectEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the schedule associated with the criteria. source: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - FORWARDED description: "Type of the source.\n * `ALL_NUMBERS` - Select to reject calls from Any Phone Number.\n * `SPECIFIC_NUMBERS` - Select to reject calls from Select Phone Numbers.\n * `FORWARDED` - Select to reject calls that have been forwarded.\n" rejectEnabled: type: boolean example: true description: Determines whether selective call reject is applied for calls matching this criteria. If `true`, selective call reject is applied. If `false`, this criteria acts as a 'Don't Reject' rule, preventing call rejections. Criteria with rejectEnabled set to false have precedence over criteria with rejectEnabled set to true. ScheduleLevel: type: string enum: - PEOPLE - GROUP description: " * `PEOPLE` - The schedule level that specifies that criteria is of People level.\n * `GROUP` - The schedule level that specifies that criteria is of Group level.\n" ResponseId: type: object description: Response object that contains the unique identifier for the created or updated criteria. properties: id: type: string description: The unique identifier for the criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 SequentialRingCriteriaPut: type: object description: Request body for updating sequential ring criteria settings. properties: scheduleName: type: string description: Name of the schedule to be associated with the criteria. example: Holidays scheduleType: type: string enum: - businessHours - holidays description: "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" example: holidays scheduleLevel: type: string enum: - PEOPLE - LOCATION description: " * `PEOPLE` - The schedule is at the user level.\n * `LOCATION` - The schedule is at the location level.\n" example: LOCATION callsFrom: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS description: "Specifies the type of calling numbers the criteria applies to.\n * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n" example: ANY_PHONE_NUMBER anonymousCallersEnabled: type: boolean description: When `true`, means this criteria applies for anonymous callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`. example: true unavailableCallersEnabled: type: boolean description: When `true`, means this criteria applies for unavailable callers. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`. example: true phoneNumbers: type: array description: List of phone numbers to update for this criteria. Required if `callsFrom` is `SELECT_PHONE_NUMBERS`. items: type: string description: Phone number that the criteria applies to. If SELECT_PHONE_NUMBERS has been selected ringEnabled: type: boolean description: Determines whether sequential ring is applied for calls matching this criteria. If `true`, sequential ring is applied. Criteria with ringEnabled set to false have precedence over criteria with ringEnabled set to true. example: false securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps