openapi: 3.0.0 info: title: Webex Admin Address Book Call Settings For Me Phase 4 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 Phase 4 paths: /telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke: post: summary: Upload Voicemail Busy Greeting operationId: uploadVoicemailBusyGreeting description: 'Uploads a new busy greeting audio file for the authenticated user''s voicemail. This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes. Requires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.' tags: - Call Settings For Me Phase 4 parameters: [] requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: Greeting audio file in WAV format. Maximum file size is 5000 kilobytes. required: - file responses: '201': description: Created '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/voicemail/actions/noAnswerGreetingUpload/invoke: post: summary: Upload Voicemail No Answer Greeting operationId: uploadVoicemailNoAnswerGreeting description: 'Uploads a new no answer greeting audio file for the authenticated user''s voicemail. This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes. Requires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail.' tags: - Call Settings For Me Phase 4 parameters: [] requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: Greeting audio file in WAV format. Maximum file size is 5000 kilobytes. required: - file responses: '201': description: Created '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/simultaneousRing: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SimultaneousRingGet' example: enabled: true doNotRingIfOnCallEnabled: true phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationEnabled: true - phoneNumber: '+19186663950' answerConfirmationEnabled: false criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation source: SELECT_PHONE_NUMBERS ringEnabled: true criteriasEnabled: 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: Retrieve My Simultaneous Ring Settings operationId: getMySimultaneousRingSettings description: 'Retrieve simultaneous ring settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week. Retrieving settings requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me Phase 4 parameters: [] put: responses: '204': description: No Content headers: {} content: {} '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 My Simultaneous Ring Settings operationId: updateMySimultaneousRingSettings description: 'Modify simultaneous ring settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week. Modifying settings requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me Phase 4 parameters: [] requestBody: content: application/json: example: enabled: false doNotRingIfOnCallEnabled: false phoneNumbers: - phoneNumber: '+19075552859' answerConfirmationEnabled: false criteriasEnabled: false schema: $ref: '#/components/schemas/SimultaneousRingPut' /telephony/config/people/me/settings/simultaneousRing/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SimultaneousRingCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: LOCATION callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' 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.' summary: Retrieve My Simultaneous Ring Criteria operationId: getMySimultaneousRingCriteria description: 'Retrieve simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. Retrieving criteria requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me Phase 4 parameters: - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string put: responses: '204': description: No Content headers: {} content: {} '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 My Simultaneous Ring Criteria operationId: updateMySimultaneousRingCriteria description: 'Modify simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. Modifying criteria requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me Phase 4 parameters: - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string requestBody: content: application/json: example: scheduleName: Business Vacation YearEnd scheduleType: holidays scheduleLevel: LOCATION callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' ringEnabled: false schema: $ref: '#/components/schemas/SimultaneousRingCriteriaPut' delete: responses: '204': description: No Content headers: {} content: {} '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: Delete My Simultaneous Ring Criteria operationId: deleteMySimultaneousRingCriteria description: 'Delete simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. Deleting criteria requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me Phase 4 parameters: - name: id in: path description: Unique identifier for the criteria. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ schema: type: string /telephony/config/people/me/settings/simultaneousRing/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ properties: id: type: string description: Unique identifier for the newly created criteria. '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: Create My Simultaneous Ring Criteria operationId: createMySimultaneousRingCriteria description: 'Create simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week. Creating criteria requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me Phase 4 parameters: [] requestBody: content: application/json: example: scheduleName: Business Vacation scheduleType: businessHours scheduleLevel: LOCATION callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19064441748' - '+19186663950' ringEnabled: true schema: $ref: '#/components/schemas/SimultaneousRingCriteriaPost' /telephony/config/people/me/settings/guestCalling/numbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GuestCallingNumbersGet' example: phoneNumbers: - phoneNumber: '+12065551212' state: ACTIVE isMainNumber: false - phoneNumber: '+12065551213' state: INACTIVE isMainNumber: 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: Retrieve My Guest Calling Numbers operationId: getMyGuestCallingNumbers description: 'Retrieve available guest calling numbers for the authenticated user. This API returns a list of phone numbers that can be used for guest calling purposes. Retrieving guest calling numbers requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me Phase 4 parameters: [] components: schemas: SimultaneousRingCriteriaGet: type: object required: - id - callsFrom - anonymousCallersEnabled - unavailableCallersEnabled - ringEnabled example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ scheduleName: Business Vacation scheduleType: holidays scheduleLevel: LOCATION callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19075552859' - '+19186663950' ringEnabled: true properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ description: Unique identifier for criteria. scheduleName: type: string example: Business Vacation description: Name of the schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleType' scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' callsFrom: $ref: '#/components/schemas/CallsFromType' anonymousCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from anonymous callers. unavailableCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from unavailable callers. phoneNumbers: type: array items: type: string example: '+19075552859' description: The list of phone numbers that will checked against incoming calls for a match. example: - '+19075552859' - '+19186663950' ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing is enabled for calls that meet this criteria. Criteria with `ringEnabled` set to `false` take priority. SimultaneousRingPut: type: object properties: enabled: type: boolean example: true description: Simultaneous Ring is enabled or not. doNotRingIfOnCallEnabled: type: boolean example: true description: When set to `true`, the configured phone numbers won't ring when you are on a call. phoneNumbers: type: array items: $ref: '#/components/schemas/SimultaneousRingNumberPut' description: Enter up to 10 phone numbers to ring simultaneously when you receive an incoming call. example: - phoneNumber: '+19075552859' answerConfirmationEnabled: true criteriasEnabled: type: boolean example: true description: Controls whether the criteria for simultaneous ring are enabled. CallsFromType: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS description: " * `ANY_PHONE_NUMBER` - The Schedule applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - Indicates the schedule applies to select phone number defined in the `phoneNumbers` property.\n" GuestCallingNumbersGet: type: object required: - phoneNumbers example: phoneNumbers: - phoneNumber: '+12065551212' state: ACTIVE isMainNumber: false - phoneNumber: '+12065551213' state: INACTIVE isMainNumber: true properties: phoneNumbers: type: array items: $ref: '#/components/schemas/GuestCallingNumber' description: List of phone numbers available for guest calling. example: - phoneNumber: '+12065551212' state: ACTIVE isMainNumber: false 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" SimultaneousRingCriteriaPut: type: object properties: scheduleName: type: string example: Business Vacation description: Name of the schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleType' scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' callsFrom: $ref: '#/components/schemas/CallsFromType' anonymousCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from unavailable callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: '+19064441748' description: The list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. example: - '+19064441748' ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing is enabled for calls that meet this criteria. Criteria with `ringEnabled` set to `false` take priority. Source: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS description: " * `ALL_NUMBERS` - Criteria applies to all incoming numbers.\n * `SPECIFIC_NUMBERS` - Criteria applies only for specific incoming numbers.\n" GuestCallingNumber: type: object required: - phoneNumber - state - isMainNumber properties: phoneNumber: type: string example: '+12065551212' description: Phone number available for guest calling. state: type: string enum: - ACTIVE - INACTIVE description: " * `ACTIVE` - Phone number is in the active state.\n * `INACTIVE` - Phone number is in the inactive state.\n" example: ACTIVE isMainNumber: type: boolean example: false description: Indicates whether this is the location's main number. 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" SimultaneousRingNumberPut: type: object properties: phoneNumber: type: string example: '+19075552859' description: Phone number set for simultaneous ring. answerConfirmationEnabled: type: boolean example: true description: When set to `true`, the called party is required to press 1 on the keypad to confirm answer for the call. SimultaneousRingCriteriaPost: type: object required: - scheduleName - scheduleType - scheduleLevel - callsFrom - ringEnabled properties: scheduleName: type: string example: Business Vacation description: Name of the schedule which determines when the simultaneous ring is in effect. scheduleType: $ref: '#/components/schemas/ScheduleType' scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' callsFrom: $ref: '#/components/schemas/CallsFromType' anonymousCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from anonymous callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. unavailableCallersEnabled: type: boolean example: true description: When `true`, the criteria applies to calls from unavailable callers. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. phoneNumbers: type: array items: type: string example: '+19064441748' description: The list of phone numbers that will checked against incoming calls for a match. Value for this attribute is required if `callsFrom` is `SELECT_PHONE_NUMBERS`. example: - '+19064441748' ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing is enabled for calls that meet this criteria. Criteria with `ringEnabled` set to `false` take priority. SimultaneousRingCriteria: type: object required: - id - source - 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 simultaneous ring is in effect. source: $ref: '#/components/schemas/Source' description: If criteria are applicable for calls from any phone number or specific phone number. ringEnabled: type: boolean example: true description: When set to `true` simultaneous ringing is enabled for calls that meet the current criteria. Criteria with `ringEnabled` set to `false` take priority. SimultaneousRingNumberGet: type: object required: - phoneNumber - answerConfirmationRequiredEnabled properties: phoneNumber: type: string example: '+19075552859' 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. SimultaneousRingGet: type: object required: - enabled - doNotRingIfOnCallEnabled - criteriasEnabled properties: enabled: type: boolean example: true description: Simultaneous Ring is enabled or not. doNotRingIfOnCallEnabled: type: boolean example: true description: When set to `true`, the configured phone numbers won't ring when on a call. phoneNumbers: type: array items: $ref: '#/components/schemas/SimultaneousRingNumberGet' description: Enter up to 10 phone numbers to ring simultaneously when a workspace phone receives an incoming call. criteria: type: array items: $ref: '#/components/schemas/SimultaneousRingCriteria' description: A list of criteria specifying conditions when simultaneous ring is in effect. criteriasEnabled: type: boolean example: true description: When `true`, enables the selected schedule for simultaneous ring. 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