openapi: 3.0.0 info: title: Webex Admin Address Book User Call Settings (2/2) 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: User Call Settings (2/2) description: APIs for managing user call settings including music on hold, access codes, transfer numbers, digit patterns, and more. paths: /people/{personId}/features/applications: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplicationsSetting' example: ringDevicesForClickToDialCallsEnabled: true ringDevicesForGroupPageEnabled: true ringDevicesForCallParkEnabled: true browserClientEnabled: true browserClientId: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQyNDM3YzY5LTBlNmYtNGMxZS1iMTJhLTFjNGYxZTk5NDRjMA desktopClientEnabled: true desktopClientId: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg tabletClientEnabled: true tabletClientId: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg mobileClientEnabled: true mobileClientId: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg availableLineCount: 35 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' deprecated: true summary: Retrieve a person's Application Services Settings New operationId: getPersonsAppServicesSettingsNew description: 'Gets mobile and PC applications settings for a user. Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app. Requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/jobs/person/moveLocation: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MoveUsersValidationResponse' example: response: - userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY impacts: - code: 19701 message: '[Informational 19701] The identity/device profile the user is using is moved to the new group: GBKAXBRMJUXF, GNXX95CLTQ0V, HD_92dbc8b6-30d1-419f-9386-3340da658f9c, G4O4NVP7MZI5, GQGWO5BDMPLP.' - code: 19722 message: '[Informational 19722] User CLID number is set to use the new group CLID number: null.' - code: 19723 message: '[Informational 19723] New group CLID number is not configured.' errors: - code: 4202 message: '[Error 4202] The extension is not available. It is already assigned to a user: 7593. ' '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/MoveUsersStartJobResponse' example: response: name: moveusers id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk trackingId: ROUTER_ebb52b5b-d060-4164-9757-48b383423d73 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM instanceId: 10 jobExecutionStatus: - id: 10 startTime: '2023-06-08T12:05:11.798Z' lastUpdated: '2023-06-08T12:05:11.798Z' statusMessage: STARTED exitCode: UNKNOWN createdTime: '2023-06-08T12:05:11.752Z' timeElapsed: PT0S latestExecutionStatus: STARTED latestExecutionExitCode: UNKNOWN counts: totalMoves: 0 moved: 0 failed: 0 pending: 0 skipped: 0 inProgress: 0 notStarted: 0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' headers: {} content: application/json: schema: $ref: '#/components/schemas/MoveUsersErrorResponse' example: error: - code: 1026016 message: User should have either phone number or extension. '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: Validate or Initiate Move Users Job operationId: validateOrInitiateMoveUsersJob description: 'This API allows the user to perform one of the following operations: * Setting the `validate` attribute to `true` validates the user move. * Setting the `validate` attribute to `false` performs the user move.
Notes: * A maximum of `100` users can be moved at a time. * Setting the `validate` attribute to `true` only allowed for calling user. * When a single non calling user is moved, it will be moved synchronously without creating any job.
Errors occurring during the initial API request validation are captured directly in the error response, along with the appropriate HTTP status code.
Below is a list of possible error `code` values and their associated `message`, which can be found in the `errors` array during initial API request validation, regardless of the `validate` attribute value: * BATCH-400 - Attribute ''User ID'' is required. * BATCH-400 - Users list should not be empty. * BATCH-400 - Users should not be empty. * 1026006 - Attribute ''Validate'' is required. * 1026010 - User is not a valid Calling User. * 1026011 - Users list should not be empty. * 1026012 - Users should not be empty. * 1026013 - The source and the target location cannot be the same. * 1026014 - Error occurred while processing the move users request. * 1026015 - Error occurred while moving user number to target location. * 1026016 - User should have either phone number or extension. * 1026017 - Phone number is not in e164 format. * 1026018 - Selected Users list exceeds the maximum limit. * 1026019 - Duplicate entry for user is not allowed. * 1026020 - Validate ''true'' is supported only for single user. * 1026021 - Attribute location id is required for Calling user. * 1026022 - Validate ''true'' is supported for calling users only. * 1026023 - Extension and phone number is supported for calling users only. * 2150012 - User was not found
When the `validate` attribute is set to true, the API identifies and returns the `errors` and `impacts` associated with the user move in the response.
Below is a list of possible error `code` values and their associated `message`, which can be found in the `errors` array, when `validate` attribute is set to be true: * 4003 - `User Not Found` * 4007 - `User Not Found` * 4152 - `Location Not Found` * 5620 - `Location Not Found` * 4202 - `The extension is not available. It is already assigned to a user : {0}` * 8264 - `Routing profile is different with new group: {0}` * 19600 - `User has to be within an enterprise to be moved.` * 19601 - `User can only be moved to a different group within the same enterprise.` * 19602 - `Only regular end user can be moved. Service instance virtual user cannot be moved.` * 19603 - `New group already reaches maximum number of user limits.` * 19604 - `The {0} number of the user is the same as the calling line ID of the group.` * 19605 - `User is assigned services not authorized to the new group: {0}.` * 19606 - `User is in an active hoteling/flexible seating association.` * 19607 - `User is pilot user of a trunk group.` * 19608 - `User is using group level device profiles which is used by other users in current group. Following are the device profiles shared with other users: {0}.` * 19609 - `Following device profiles cannot be moved to the new group because there are already devices with the same name defined in the new group: {0}.` * 19610 - `The extension of the user is used as transfer to operator number for following Auto Attendent : {0}.` * 19611 - `Fail to move announcement file from {0} to {1}.` * 19612 - `Fail to move device management file from {0} to {1}.` * 19613 - `User is assigned service packs not authorized to the new group: {0}.` * 25008 - `Missing Mandatory field name: {0}` * 25110 - `{fieldName} cannot be less than {0} or greater than {1} characters.` * 25378 - `Target location is same as user''s current location.` * 25379 - `Error Occurred while Fetching User''s Current Location Id.` * 25381 - `Error Occurred while rolling back to Old Location Call recording Settings` * 25382 - `Error Occurred while Disabling Call Recording for user which is required Before User can be Moved` * 25383 - `OCI Error while moving user` * 25384 - `Error Occurred while checking for Possible Call Recording Impact.` * 25385 - `Error Occurred while getting Call Recording Settings` * 27559 - `The groupExternalId search criteria contains groups with different calling zone.` * 27960 - `Parameter isWebexCalling, newPhoneNumber, or newExtension can only be set in Webex Calling deployment mode.` * 27961 - `Parameter isWebexCalling shall be set if newPhoneNumber or newExtension is set.` * 27962 - `Work space cannot be moved.` * 27963 - `Virtual profile user cannot be moved.` * 27965 - `The user''s phone number: {0}, is same as the current group charge number.` * 27966 - `The phone number, {0}, is not available in the new group.` * 27967 - `User is configured as the ECBN user for another user in the current group.` * 27968 - `User is configured as the ECBN user for the current group.` * 27969 - `User is associated with DECT handset(s): {0}` * 27970 - `User is using a customer managed device: {0}` * 27971 - `User is using an ATA device: {0}` * 27972 - `User is in an active hotdesking association.` * 27975 - `Need to unassign CLID number from group before moving the number to the new group. Phone number: {0}` * 27976 - `Local Gateway configuration is different with new group. Phone number: {0}` * 1026015 - `Error occurred while moving user number to target location` * 10010000 - `Total numbers exceeded maximum limit allowed` * 10010001 - `to-location and from-location cannot be same` * 10010002 - `to-location and from-location should belong to same customer` * 10010003 - `to-location must have a carrier` * 10010004 - `from-location must have a carrier` * 10010005 - `Different Carrier move is not supported for non-Cisco PSTN carriers.` * 10010006 - `Number move not supported for WEBEX_DIRECT carriers.` * 10010007 - `Numbers out of sync, missing on CPAPI` * 10010008 - `from-location not found or pstn connection missing in CPAPI` * 10010010 - `from-location is in transition` * 10010009 - `to-location not found or pstn connection missing in CPAPI` * 10010011 - `to-location is in transition` * 10010012 - `Numbers don''t have a carrier Id` * 10010013 - `Location less numbers don''t have a carrier Id` * 10010014 - `Different Carrier move is not supported for numbers with different country or region.` * 10010015 - `Numbers contain mobile and non-mobile types.` * 10010016 - `To/From location carriers must be same for mobile numbers.` * 10010017 - `Move request for location less number not supported` * 10010200 - `Move request for more than one block number is not supported` * 10010201 - `Cannot move block number as few numbers not from the block starting %s to %s` * 10010202 - `Cannot move block number as few numbers failed VERIFICATION from the block %s to %s` * 10010203 - `Cannot move block number as few numbers missing from the block %s to %s` * 10010204 - `Cannot move number as it is NOT a part of the block %s to %s` * 10010205 - `Move request for Cisco PSTN block order not supported.` * 10010299 - `Move order couldn''t be created as no valid number to move` * 10030000 - `Number not found` * 10030001 - `Number does not belong to from-location` * 10030002 - `Number is not present in CPAPI` * 10030003 - `Number assigned to an user or device` * 10030004 - `Number not in Active status` * 10030005 - `Number is set as main number of the location` * 10030006 - `Number has pending order associated with it` * 10030007 - `Number belongs to a location but a from-location was not set` * 10030008 - `Numbers from multiple carrier ids are not supported` * 10030009 - `Location less number belongs to a location. from-location value is set to null or no location id` * 10030010 - `One or more numbers are not portable.` * 10030011 - `Mobile number carrier was not set` * 10030012 - `Number must be assigned for assigned move` * 10050000 - `Failed to update customer reference for phone numbers on carrier` * 10050001 - `Failed to update customer reference` * 10050002 - `Order is not of operation type MOVE` * 10050003 - `CPAPI delete call failed` * 10050004 - `Not found in database` * 10050005 - `Error sending notification to WxcBillingService` * 10050006 - `CPAPI provision number as active call failed with status %s ,reason %s` * 10050007 - `Failed to update E911 Service` * 10050008 - `Target location does not have Inbound Toll Free license` * 10050009 - `Source location or Target location subscription found cancelled or suspended` * 10050010 - `Moving On Premises or Non Integrated CCP numbers from one location to another is not supported.` * 10099999 - `{Error Code} - {Error Message}`
Below is a list of possible impact `code` values and their associated `message`, which can be found in the `impacts` array, when `validate` attribute is set to be true: * 19701 - `The identity/device profile the user is using is moved to the new group: {0}.` * 19702 - `The user level customized incoming digit string setting is removed from the user. User is set to use the new group setting.` * 19703 - `The user level customized outgoing digit plan setting is removed from the user. User is set to use the new group setting.` * 19704 - `The user level customized enhanced outgoing calling plan setting is removed from the user. User is set to use the new group setting.` * 19705 - `User is removed from following group services: {0}.` * 19706 - `The current group schedule used in any criteria is removed from the service settings.` * 19707 - `User is removed from the department of the old group.` * 19708 - `User is changed to use the default communication barring profile of the new group.` * 19709 - `The communication barring profile of the user is assigned to the new group: {0}.` * 19710 - `The charge number for the user is removed.` * 19711 - `The disabled FACs for the user are removed because they are not available in the new group.` * 19712 - `User is removed from trunk group.` * 19713 - `The extension of the user is reset to empty due to either the length is out of bounds of the new group, or the extension is already taken in new group.` * 19714 - `The extension of the following alternate number is reset to empty due to either the length out of bounds of the new group or the extension is already taken in new group: {0}.` * 19715 - `The collaborate room using current group default collaborate bridge is moved to the default collaborate bridge of the new group.` * 19716 - `Previously stored voice messages of the user are no longer available. The new voice message will be stored on the mail server of the new group.` * 19717 - `The primary number, alternate numbers or fax messaging number of the user are assigned to the new group: {0}.` * 19718 - `Following domains are assigned to the new group: {0}.` * 19719 - `The NCOS of the user is assigned to the new group: {0}.` * 19720 - `The office zone of the user is assigned to the new group: {0}.` * 19721 - `The announcement media files are relocated to the new group directory.` * 19722 - `User CLID number is set to use the new group CLID number: {0}.` * 19723 - `New group CLID number is not configured.` * 19724 - `The group level announcement file(s) are removed from the user''s music on hold settings.` * 25388 - `Target Location Does not Have Vendor Configured. Call Recording for user will be disabled` * 25389 - `Call Recording Vendor for user will be changed from:{0} to:{1}` * 25390 - `Dub point of user is moved to new external group` * 25391 - `Error Occurred while moving Call recording Settings to new location` * 25392 - `Error Occurred while checking for Possible Call Recording Impact.` * 25393 - `Sending Billing Notification Failed` This API requires a full administrator auth token with the scopes `spark-admin:telephony_config_write`, `spark-admin:people_write`, and `identity:groups_rw`.' tags: - User Call Settings (2/2) parameters: - name: orgId in: query description: Create Move Users job for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: usersList: - locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA validate: false users: - userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9teW5hbWUgaXNvcHRpdXMGEyltZXdlYXJlMGEyMGEyNWM1OWE phoneNumber: '+18632520486' - userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTJhYjliZC1jNmUyLTZlYWUtMWE5YS01ZWZhMGEyNWMxNmE extension: '28544' - locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDkwNS04MGViLWRjY2NiM2VlMTQ0MwFG validate: false users: - userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY extension: '29376' phoneNumber: '+18947028597' schema: $ref: '#/components/schemas/MoveUsersStartJobObject' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/JobListResponse' example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE trackingId: ROUTER_6475F43E-A25A-01BB-76CC-AC108AF376CC sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM instanceId: 328660 jobExecutionStatus: - id: 332387 startTime: '2023-05-30T13:04:00.469Z' endTime: '2023-05-30T13:04:03.252Z' lastUpdated: '2023-05-30T13:04:03.574Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-05-30T13:04:00.457Z' stepExecutionStatuses: - id: 1549115 startTime: '2023-05-30T13:04:00.493Z' endTime: '2023-05-30T13:04:03.245Z' lastUpdated: '2023-05-30T13:04:03.246Z' statusMessage: COMPLETED exitCode: COMPLETED name: moveusersvalidateAndMove timeElapsed: PT2.752S timeElapsed: PT2.752S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: totalMoves: 1 moved: 1 failed: 0 pending: 0 skipped: 0 csvFile: 02124eef-8af7-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12 csvFileExpiryTime: '2023-07-12T12:20:33.503Z' fileFormat: text/csv - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8yNjFjZTRkZi03MmQwLTRjOTgtYWI0MS03ZDJhOTM4ZjhmZDk trackingId: ROUTER_6475F3F5-9D6C-01BB-4C40-AC108AF34C40 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM instanceId: 328658 jobExecutionStatus: - id: 332385 startTime: '2023-05-30T13:02:47.830Z' endTime: '2023-05-30T13:02:51.035Z' lastUpdated: '2023-05-30T13:02:51.353Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-05-30T13:02:47.813Z' stepExecutionStatuses: - id: 1549111 startTime: '2023-05-30T13:02:47.856Z' endTime: '2023-05-30T13:02:51.028Z' lastUpdated: '2023-05-30T13:02:51.028Z' statusMessage: COMPLETED exitCode: COMPLETED name: moveusersvalidateAndMove timeElapsed: PT3.172S timeElapsed: PT3.172S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: totalMoves: 1 moved: 1 failed: 0 pending: 0 skipped: 0 csvFile: 02124eef-7be6-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12 csvFileExpiryTime: '2023-07-12T12:20:33.503Z' fileFormat: text/csv '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Move Users Jobs operationId: listMoveUsersJobs description: 'Lists all the Move Users jobs for the given organization in order of most recent job to oldest job irrespective of its status. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: orgId in: query description: Retrieve list of Move Users jobs for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM schema: type: string minLength: 1 maxLength: 128 - name: start in: query description: Start at the zero-based offset in the list of jobs. Default is 0. example: 0 schema: type: number minimum: 0 - name: max in: query description: Limit the number of jobs returned to this maximum count. Default is 2000. example: 2000 schema: type: number minimum: 0 /telephony/config/jobs/person/moveLocation/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/JobDetailsResponseById' example: name: moveusers id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE trackingId: ROUTER_6475F43E-A25A-01BB-76CC-AC108AF376CC sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM instanceId: 328660 jobExecutionStatus: - id: 332387 startTime: '2023-05-30T13:04:00.469Z' endTime: '2023-05-30T13:04:03.252Z' lastUpdated: '2023-05-30T13:04:03.574Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-05-30T13:04:00.457Z' stepExecutionStatuses: - id: 1549115 startTime: '2023-05-30T13:04:00.493Z' endTime: '2023-05-30T13:04:03.245Z' lastUpdated: '2023-05-30T13:04:03.246Z' statusMessage: COMPLETED exitCode: COMPLETED name: moveusersvalidateAndMove timeElapsed: PT2.752S timeElapsed: PT2.752S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: totalMoves: 1 moved: 1 failed: 0 pending: 0 skipped: 0 csvFile: 02124eef-7be6-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12 csvFileExpiryTime: '2023-07-12T12:20:33.503Z' fileFormat: text/csv csvFileDownloadUrl: https://files-int-us-east-1.webexcontent.com/5ab33047-d7ad-42dd-83c5-2e73da63b2ad/8c54b800-10ed-11ee-97c3-a38ed64ceaf4?x-amz-meta-tracking-id=NA_33b1a151-4c47-46a5-8fc5-09f3111c4313&x-amz-meta-user-id=ef2e385f-acad-4e90-8c10-c6532aa0c28d&Expires=1687440028&Signature=ckIcTq-7mUfcdsvSbAR5cUGC76FfyJ6D06~bKXuCrfHkku-eqPsMImRIBCqvWoBRQ1nwGdZk043AFXrwKMxDR9y~GJkzPVAjZwEU3Rr1pK-2aVEDMzP8AVlMYQmJPrmVFlnX8AxDh9YnCeoGUhwUbT~wjyj~NJP3PGfc-hwyXWnFTmdvL3Ehn66z9BQxKksZMOWCyghd~9otoBVC-WyA1Nx2LDOT1qmlLeqN2xwWpdu5Atll0tPUQaOQbCP3-bnOcmL0tR~2gUzfBMUhsW7UO1IPD451va8qcw687~Mglu5VPdpWlIjVXZu6Qk1uCIWSQ0czRDOiFH6RKWtQCD95qw__&Key-Pair-Id=APKAJADAKLCI2FW2U32Q '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Move Users Job Status operationId: getMoveUsersJobStatus description: 'Returns the status and other details of the job. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: jobId in: path description: Retrieve job details for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Retrieve job details for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM schema: type: string minLength: 1 maxLength: 128 /telephony/config/jobs/person/moveLocation/{jobId}/actions/pause/invoke: post: responses: '202': description: Accepted headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Pause the Move Users Job operationId: pauseMoveUsersJob description: 'Pause the running Move Users Job. A paused job can be resumed. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: jobId in: path description: Pause the Move Users job for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Pause the Move Users job for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk schema: type: string minLength: 1 maxLength: 128 /telephony/config/jobs/person/moveLocation/{jobId}/actions/resume/invoke: post: responses: '202': description: Accepted headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Resume the Move Users Job operationId: resumeMoveUsersJob description: 'Resume the paused Move Users Job that is in paused status. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: jobId in: path description: Resume the Move Users job for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Resume the Move Users job for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk schema: type: string minLength: 1 maxLength: 128 /telephony/config/jobs/person/moveLocation/{jobId}/errors: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseObject' example: items: - itemNumber: 1 item: 52efdff9-9db6-438d-9b96-638365789353 error: key: '400' message: - description: '[Error 19605] User is assigned services not authorized to the new group: [Basic Call Logs].' code: '19605' location: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U3ZjlmZTQ0LTI3ZjEtNGE2NC04NmJhLTM1NmE0YjUyMTk4ZA trackingId: NA_097fb6e7-e972-41b3-a9e1-bd5a4a31eb33 paging: next: [] prev: null limit: 50 offset: 0 pages: null count: 1 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Move Users Job errors operationId: listMoveUsersJobErrors description: 'Lists all error details of Move Users job. This will not list any errors if `exitCode` is `COMPLETED`. If the status is `COMPLETED_WITH_ERRORS` then this lists the cause of failures. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: jobId in: path description: Retrieve the error details for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Retrieve list of jobs for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM schema: type: string minLength: 1 maxLength: 128 - name: start in: query description: Specifies the error offset from the first result that you want to fetch. example: 0 schema: type: number minimum: 0 - name: max in: query description: Specifies the maximum number of records that you want to fetch. example: 100 schema: type: number default: 2000 /telephony/config/people/{personId}/musicOnHold: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetMusicOnHoldObject' example: mohEnabled: true mohLocationEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Music On Hold Settings for a Person operationId: retrieveMusicOnHoldSettingsForPerson description: 'Retrieve the person''s music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. Retrieving a person''s music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) externalDocs: description: Music On Hold API Documentation url: https://developer.webex.com/docs/api/v1/webex-calling-person-settings-music-on-hold parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Music On Hold Settings for a Person operationId: configureMusicOnHoldSettingsForPerson description: 'Configure a person''s music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold settings for a person, music on hold setting must be enabled for this location. Updating a person''s music on hold settings requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: mohEnabled: true greeting: CUSTOM audioAnnouncementFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/PutMusicOnHoldObject' /telephony/config/people/{personId}/outgoingPermission/accessCodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListGet' example: useCustomAccessCodes: true accessCodes: - code: '4856' description: Marketing's access code level: CUSTOM - code: '3421' description: Finance's access code level: CUSTOM '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Access Codes for a Person operationId: retrieveAccessCodesForPerson description: 'Retrieve the person''s access codes. Access codes are used to bypass permissions. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Access Codes for a Person operationId: modifyAccessCodesForPerson description: 'Modify a person''s access codes. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: useCustomAccessCodes: true deleteCodes: - '4856' - '2421' schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeListPatch' post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Access Codes for a Person operationId: createAccessCodesForPerson description: 'Create new Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: code: '4856' description: Marketing's access code schema: $ref: '#/components/schemas/UserPlaceAuthorizationCodeAdd' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Access Codes for a Person operationId: deleteAccessCodesForPerson description: 'Deletes all Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/outgoingPermission/autoTransferNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TransferNumberGet' example: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Transfer Numbers for a Person operationId: retrieveTransferNumbersForPerson description: 'Retrieve the person''s transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Transfer Numbers for a Person operationId: modifyTransferNumbersForPerson description: 'Modify a person''s transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers. This API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: useCustomTransferNumbers: true autoTransferNumber1: '+1205553650' autoTransferNumber2: '+1205553651' autoTransferNumber3: '+1205553652' schema: $ref: '#/components/schemas/TransferNumberPatch' /telephony/config/people/{personId}/outgoingPermission/digitPatterns: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternGetListObject' example: useCustomDigitPatterns: false digitPatterns: - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern1 pattern: 2XXXX action: ALLOW transferEnabled: false - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V5 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Digit Patterns for a Person operationId: retrieveDigitPatternsForPerson description: 'Retrieve the person''s digit patterns. Digit patterns are used to bypass permissions. Retrieving digit patterns requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created digit pattern. example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Digit Patterns for a Person operationId: createDigitPatternsForPerson description: 'Create a new digit pattern for the given person. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: name: DigitPattern3 pattern: 3XXX action: ALLOW transferEnabled: false schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternPostObject' put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify the Digit Pattern Category Control Settings for a Person operationId: modifyDigitPatternCategoryControlSettingsForPerson description: 'Modifies whether this user uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: useCustomDigitPatterns: true schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternCategoryControlPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete all Digit Patterns for a Person operationId: deleteAllDigitPatternsPerson description: 'Delete all digit patterns for a Person. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserDigitPatternObject' example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: DigitPattern2 pattern: 1XXXX action: ALLOW transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Digit Pattern Details for a Person operationId: retrieveDigitPatternDetailsPerson description: 'Retrieve the digit pattern details for a person. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Digit Pattern for a Person operationId: modifyDigitPatternForPerson description: 'Modify a digit pattern for a Person. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: name: DigitPattern4 pattern: 3XXX2 schema: $ref: '#/components/schemas/UserOutgoingPermissionDigitPatternPatchObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Digit Pattern for a Person operationId: deleteADigitPatternPerson description: 'Delete a digit pattern for a Person. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw schema: type: string minLength: 1 maxLength: 128 - name: digitPatternId in: path description: Unique identifier for the digit pattern. required: true example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/numbers: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Assign or Unassign numbers to a person operationId: assignOrUnassignNumbersToAPerson description: 'Assign or unassign alternate phone numbers to a person. Each location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service. Assigning or unassigning an alternate phone number to a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identitfier of the person. required: true example: '''Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iNTcwZGY3ZC00MjBkLTQ4NGYtYWE5OS1kMzcxOGZjNDUxZDA=''' schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization of the Route Group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: enableDistinctiveRingPattern: true phoneNumbers: - directNumber: '+12145553567' extension: '0007' primary: false action: ADD ringPattern: SHORT_LONG_SHORT - directNumber: '+12145553569' extension: 0009 primary: false action: DELETE ringPattern: SHORT_LONG_SHORT schema: $ref: '#/components/schemas/UserNumbersPatch' /telephony/config/people/{personId}/preferredAnswerEndpoint: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/endpointInformation' example: preferredAnswerEndpointId: Y2lzY29z... endpoints: - id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) - id: Y2lzY29b... type: APPLICATION name: Webex Desktop Application '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Preferred Answer Endpoint operationId: getPreferredAnswerEndpoint description: 'Get the person''s preferred answer endpoint and the list of endpoints available for selection. The preferred answer endpoint is null if one has not been selected. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality. These endpoints can be used by the following Call Control API''s that allow the person to specify an endpointId to use for the call:
+ [/v1/telephony/calls/dial](/docs/api/v1/call-controls/dial)
+ [/v1/telephony/calls/retrieve](/docs/api/v1/call-controls/retrieve)
+ [/v1/telephony/calls/pickup](/docs/api/v1/call-controls/pickup)
+ [/v1/telephony/calls/barge-in](/docs/api/v1/call-controls/barge-in)
+ [/v1/telephony/calls/answer](/docs/api/v1/call-controls/answer)
This API requires `spark:telephony_config_read` or `spark-admin:telephony_config_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29z... schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Preferred Answer Endpoint operationId: modifyPreferredAnswerEndpoint description: 'Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `preferredAnswerEndpointId` attribute must be set to null.
This API requires `spark:telephony_config_write` or `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29z... schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: preferredAnswerEndpointId: Y2lzY29z... schema: $ref: '#/components/schemas/EndpointIdType' /telephony/config/people/{personId}/applications/{applicationId}/availableMembers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableSharedLineMemberList' example: members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE firstName: John lastName: Doe phoneNumber: '1234567890' extension: '0000' routingPrefix: '1234' esn: '12340000' lineType: SHARED_CALL_APPEARANCE location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw name: MainOffice '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' deprecated: true summary: Search Shared-Line Appearance Members operationId: searchSharedLineAppearanceMembers description: 'Get members available for shared-line assignment to a Webex Calling Apps Desktop device. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 - name: applicationId in: path description: A unique identifier for the application. required: true example: 2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Number of records per page. example: 0 schema: type: number minimum: 0 - name: start in: query description: Page number. example: 0 schema: type: number minimum: 0 - name: location in: query description: Location ID for the user. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string minLength: 1 maxLength: 128 - name: name in: query description: Search for users with names that match the query. example: john schema: type: string minLength: 1 maxLength: 128 - name: number in: query description: Search for users with numbers that match the query. example: '1234567890' schema: type: string minLength: 1 maxLength: 128 - name: order in: query description: Sort by first name (`fname`) or last name (`lname`). example: fname schema: type: string minLength: 1 maxLength: 128 - name: extension in: query description: Search for users with extensions that match the query. example: '1111' schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/applications/{applicationId}/members: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetSharedLineMemberList' example: model: Business Communicator - PC members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE firstName: John lastName: Doe phoneNumber: '2056852221' extension: '1111' routingPrefix: '1234' esn: '12341111' port: 1 primaryOwner: 'true' lineType: SHARED_CALL_APPEARANCE lineWeight: 1 hostIP: 198.168.0.1 remoteIP: 198.168.0.2 hotlineEnabled: true hotlineDestination: '1234' allowCallDeclineEnabled: true lineLabel: share line label memberType: PEOPLE location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw name: MainOffice maxLineCount: 10 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' deprecated: true summary: Get Shared-Line Appearance Members operationId: getSharedLineAppearanceMembers description: 'Get primary and secondary members assigned to a shared line on a Webex Calling Apps Desktop device. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 - name: applicationId in: path description: A unique identifier for the application. required: true example: 2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' deprecated: true summary: Put Shared-Line Appearance Members operationId: modifySharedLineAppearanceMembers description: 'Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps Desktop device. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 - name: applicationId in: path description: A unique identifier for the application. required: true example: 2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: schema: $ref: '#/components/schemas/PutSharedLineMemberList' /telephony/config/people/{personId}/voicemail/passcode: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a person's voicemail passcode operationId: modifyPersonVoicemailPasscode description: 'Modify a person''s voicemail passcode. Modifying a person''s voicemail passcode requires a full administrator, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Modify voicemail passcode for this person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTu+/vQ schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Modify voicemail passcode for a person in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: passcode: '1551234' schema: $ref: '#/components/schemas/ModifyVoicemailPasscode' /telephony/voiceMessages/summary: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: newMessages: type: number minimum: 0 example: 2 description: The number of new (unread) voicemail messages. oldMessages: type: number minimum: 0 example: 5 description: The number of old (read) voicemail messages. newUrgentMessages: type: number minimum: 0 description: The number of new (unread) urgent voicemail messages. oldUrgentMessages: type: number minimum: 0 example: 1 description: The number of old (read) urgent voicemail messages. example: newMessages: 2 oldMessages: 5 newUrgentMessages: 0 oldUrgentMessages: 1 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Message Summary operationId: getMessageSummary description: Get a summary of the voicemail messages for the user. tags: - User Call Settings (2/2) parameters: [] /telephony/voiceMessages: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/VoiceMessageDetails' example: items: - id: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx duration: 38 callingParty: name: John Smith number: '+12223334444' personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg= placeId: Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ3MWEyLTRlOTItOTFhYi05ZjJmLWJjYTEzNTAxM2ExNA== privacyEnabled: false urgent: false confidential: false read: true faxPageCount: 2 created: '2021-11-14T17:00:00.000Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Messages operationId: listMessages description: Get the list of all voicemail messages for the user. tags: - User Call Settings (2/2) parameters: - name: lineOwnerId in: query description: The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API. example: Y2lzY29z... schema: type: string /telephony/voiceMessages/{messageId}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Message operationId: deleteMessage description: Delete a specfic voicemail message for the user. tags: - User Call Settings (2/2) parameters: - name: messageId in: path description: The message identifer of the voicemail message to delete required: true schema: type: string minLength: 1 maxLength: 128 /telephony/voiceMessages/markAsRead: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Mark As Read operationId: markAsRead description: 'Update the voicemail message(s) as read for the user. If the `messageId` is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read.' tags: - User Call Settings (2/2) parameters: [] requestBody: content: application/json: example: messageId: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx lineOwnerId: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ schema: type: object properties: messageId: type: string example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx description: The voicemail message identifier of the message to mark as read. If the `messageId` is not provided, then all voicemail messages for the user are marked as read. lineOwnerId: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ description: The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API. /telephony/voiceMessages/markAsUnread: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Mark As Unread operationId: markAsUnread description: 'Update the voicemail message(s) as unread for the user. If the `messageId` is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread.' tags: - User Call Settings (2/2) parameters: [] requestBody: content: application/json: example: messageId: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx lineOwnerId: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ schema: type: object properties: messageId: type: string example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx description: The voicemail message identifier of the message to mark as unread. If the `messageId` is not provided, then all voicemail messages for the user are marked as unread. lineOwnerId: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ description: The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API. /telephony/config/people/{personId}/agent/availableCallerIds: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableCallerIdList' example: availableCallerIds: - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYmRlNDE4NDAtNmVmYS00YTkzLTk5YmEtNDc5Y2QxYTFjZmI5 type: CALL_QUEUE name: TestCallQueue extension: '6001' - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy type: HUNT_GROUP name: TestHuntGroup phoneNumber: '+441234200090' extension: '6002' - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZTY1NjgzOTMtZTQ5MC00OGQ2LTg3OTgtY2IyZmY3YzkwNzg0 type: CALL_QUEUE name: TestCallQueueSecond phoneNumber: '+441234200091' extension: '6003' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Agent's List of Available Caller IDs operationId: retrieveAgentsListOfAvailableCallerIDs description: 'Get the list of call queues and hunt groups available for caller ID use by this person as an agent. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/agent/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AgentCallerId' example: selectedCallerId: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMzc4NzRjOGUtMzRhOS00NzFjLWI1N2QtMzAxNTJkZjlmMjQx type: CALL_QUEUE name: new ram phoneNumber: '+81123456890' extension: 09899 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Agent's Caller ID Information operationId: retrieveAgentsCallerIDInformation description: 'Retrieve the Agent''s Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue''s Caller ID, Hunt Group''s Caller ID or their own configured Caller ID. This API requires a full admin or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Agent's Caller ID Information operationId: modifyAgentCallerIdInformation description: 'Modify Agent''s Caller ID Information. Each Agent will be able to set their outgoing Caller ID as either the designated Call Queue''s Caller ID or Hunt Group''s Caller ID or their own configured Caller ID This API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: selectedCallerId: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvZWZkN2JjYzAtMjNkNS00NWM2LTk1N2YtZWNhYWEyZDU0M2Uw schema: $ref: '#/components/schemas/PutAgentCallCallerId' /telephony/config/people/{personId}/features/callBridge: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallBridgeInfo' example: warningToneEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Bridge Settings for a Person operationId: readCallBridgeSettingsPerson description: 'Retrieve a person''s Call Bridge settings. This API requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Bridge Settings for a Person operationId: configureCallBridgeSettingsPerson description: 'Configure a person''s Call Bridge settings. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: warningToneEnabled: true schema: $ref: '#/components/schemas/CallBridgePut' /telephony/config/people/{personId}/secondary/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonSecondaryAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Secondary Available Phone Numbers operationId: getPersonSecondaryAvailablePhoneNumbers description: 'List standard numbers that are available to be assigned as a person''s secondary phone number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/people/{personId}/faxMessage/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonFaxMessageAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Fax Message Available Phone Numbers operationId: getPersonFaxMessageAvailablePhoneNumbers description: 'List standard numbers that are available to be assigned as a person''s FAX message number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/people/{personId}/callForwarding/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonCallForwardAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYm1kMmVIcHNabTgwWVVBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: CALL_QUEUE displayName: Test call queue '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Call Forward Available Phone Numbers operationId: getPersonCallForwardAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as a person''s call forward number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string minLength: 1 maxLength: 128 - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/primary/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonPrimaryAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false includedTelephonyTypes: MOBILE_NUMBER mobileNetwork: mobileNetwork routingProfile: AttRtPf telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Primary Available Phone Numbers operationId: getPersonPrimaryAvailablePhoneNumbers description: 'List numbers that are available to be assigned as a person''s primary phone number. By default, this API returns standard and mobile numbers from all locations that are unassigned. The parameters `licenseType` and `locationId` must align with the person''s settings to determine the appropriate number for assignment. Failure to provide these parameters may result in the unsuccessful assignment of the returned number. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: locationId in: query description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: licenseType in: query description: Used to search numbers according to the person's `licenseType` to which the number will be assigned. example: Webex Calling Professional schema: type: string enum: - Webex Calling Professional - Webex Calling Standard /telephony/config/people/{personId}/emergencyCallbackNumber/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonECBNAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NWQ3MmYwNS00NDYzLTQxYzktYjI0Ni01MDhkMDM2YzJhOTE type: VIRTUAL_LINE displayName: Test VL - phoneNumber: '+12056350004' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWnpOcmEybHNkalV3ZDBCbWJHVjRNaTVqYVhOamJ5NWpiMjA9 type: HUNT_GROUP displayName: Test HG '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person ECBN Available Phone Numbers operationId: getPersonEcbnAvailablePhoneNumbers description: 'List standard numbers that are available to be assigned as a person''s emergency callback number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/callIntercept/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonCallInterceptAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2RtbHRNWFV6WjJkaWRFQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09 type: AUTO_ATTENDANT displayName: Test Autoattendant '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Call Intercept Available Phone Numbers operationId: getPersonCallInterceptAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as a person''s call intercept number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: 0 schema: type: number minimum: 0 - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: - '+12056852221' - '+12056852222' schema: type: array items: type: string example: '+12056852221' description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string minLength: 1 maxLength: 128 - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/settings/msTeams: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserMSTeamsSettingsObject' example: personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE settings: - settingName: HIDE_WEBEX_APP level: PEOPLE value: true lastModified: '2024-02-24T07:22:23.494198Z' - settingName: PRESENCE_SYNC level: ORGANIZATION value: false lastModified: '2024-02-24T07:21:23.494198Z' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve a Person's MS Teams Settings operationId: getPersonMSTeamsSettings description: '
Not supported for Webex for Government (FedRAMP)
Retrieve a person''s MS Teams settings. At a person level, MS Teams settings allow access to retrieving the `HIDE WEBEX APP` and `PRESENCE SYNC` settings. To retrieve a person''s MS Teams settings requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure a Person's MS Teams Setting operationId: configurePersonMSTeamsSetting description: '
Not supported for Webex for Government (FedRAMP)
Configure a Person''s MS Teams setting. MS Teams settings can be configured at the person level. Requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: settingName: HIDE_WEBEX_APP value: true schema: $ref: '#/components/schemas/ModifyUserMSTeamsSettingsObject' /telephony/config/people/{personId}/features/personalAssistant: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PersonalAssistantGet' example: enabled: true presence: BUSINESS_TRIP untilDateTime: '2022-08-24T06:18:31.092Z' transferEnabled: true transferNumber: '+14126525012' alerting: ALERT_ME_FIRST alertMeFirstNumberOfRings: 3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Personal Assistant operationId: getPersonalAssistant description: 'Retrieve Personal Assistant details for a specific user. Personal Assistant is used to manage a user''s incoming calls when they are away. Retrieving Personal Assistant details requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Get Personal Assistant details for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Personal Assistant operationId: modifyPersonalAssistant description: 'Update Personal Assistant details for a specific user. Personal Assistant is used to manage a user''s incoming calls when they are away. Updating Personal Assistant details requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Update Personal Assistant details for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: enabled: true presence: BUSINESS_TRIP untilDateTime: '2022-08-24T06:18:31.092Z' transferEnabled: true transferNumber: '+14126525012' alerting: ALERT_ME_FIRST alertMeFirstNumberOfRings: 3 schema: $ref: '#/components/schemas/PersonalAssistantPatch' /telephony/config/people/{personId}/modeManagement/availableFeatures: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - features properties: features: type: array items: $ref: '#/components/schemas/UserModeManagementAvailableFeaturesObject' description: Array of features. example: features: - id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ name: Test Auto Attendant type: AUTO_ATTENDANT phoneNumber: '+19705550028' extension: 0028 - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNWMwZmYzZjctZjY2YS00NGQwLTlhODktZGY5N2U5MThkNjcw name: Test Call Queue type: CALL_QUEUE phoneNumber: '2055552221' extension: '0007' - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy name: Test Hunt Group type: HUNT_GROUP phoneNumber: '2055552221' extension: '0023' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve the List of Available Features operationId: getListOfAvailableFeatures description: 'Retrieve a list of feature identifiers that can be assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`. Features with mode-based call forwarding enabled can be assigned to a user for `Mode Management`. Retrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the user. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI schema: type: string minLength: 1 maxLength: 128 - name: name in: query description: List features whose `name` contains this string. example: Day schema: type: string minLength: 1 maxLength: 128 - name: phoneNumber in: query description: List features whose phoneNumber contains this matching string. example: '+35391884653' schema: type: string minLength: 1 maxLength: 128 - name: extension in: query description: List features whose `extension` contains this matching string. example: '1234' schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Maximum number of features to return in a single page. schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: 0 schema: type: number minimum: 0 - name: order in: query description: Sort the list of features based on `name`, `phoneNumber`, or `extension`, either `asc`, or `desc`. example: name-asc schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Retrieve features list from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/modeManagement/features: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - features properties: features: type: array items: $ref: '#/components/schemas/UserModeManagementFeatureObject' description: Array of assigned features. example: features: - id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ name: Test Auto Attendant type: AUTO_ATTENDANT phoneNumber: '+19705550028' extension: 0028 modeBasedForwardingEnabled: true forwardDestination: '+14259964241' currentOperatingModeName: Day Operating Mode currentOperatingModeId: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ exceptionType: AUTOMATIC_SWITCH_BACK_EARLY_START location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: Banglore - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNWMwZmYzZjctZjY2YS00NGQwLTlhODktZGY5N2U5MThkNjcw name: Test Call Queue type: CALL_QUEUE phoneNumber: '2055552221' extension: '0007' modeBasedForwardingEnabled: true forwardDestination: '+19705550028' currentOperatingModeName: Outage Operating Mode currentOperatingModeId: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2VkMjg0NjE1LWY3ZDgtNDNhOC1iOGJmLTVkYmU2ZjMzMTNjZQ exceptionType: MANUAL_SWITCH_BACK location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: Banglore - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy name: Test Hunt Group type: HUNT_GROUP phoneNumber: '2055552221' extension: '0023' modeBasedForwardingEnabled: true forwardDestination: '+19705550028' currentOperatingModeName: Day Operating Mode currentOperatingModeId: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ exceptionType: MANUAL_SWITCH_BACK location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: Banglore '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve the List of Features Assigned to a User for Mode Management operationId: getListOfFeaturesAssignedToAUserModeManagement description: 'Retrieve a list of feature identifiers that are already assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`. A maximum of 50 features can be assigned to a user for `Mode Management`. Features with mode-based call forwarding enabled can be assigned to a user for `Mode Management`. Retrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the user. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Retrieve features list from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '200': description: OK headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Assign a List of Features to a User for Mode Management operationId: assignListOfFeaturesToAUserModeManagement description: 'Assign a user a list of feature identifiers for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`. A maximum of 50 features can be assigned to a user for `Mode Management`. Updating mode management settings for a user requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the user. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Retrieve features list from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: featureIds: - Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ - Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNWMwZmYzZjctZjY2YS00NGQwLTlhODktZGY5N2U5MThkNjcw - Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvOTExNmRmZDMtZGQ4ZS00YTk5LTg1MmYtMjFiYmMxOGNkNzcy schema: $ref: '#/components/schemas/ArrayOfFeatureIdsObject' /telephony/config/people/{personId}/selectiveAccept: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveAcceptCallGet' example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI scheduleName: demo_schedule source: ALL_NUMBERS acceptEnabled: true - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5MjY0ODQ3NzcyNzE scheduleName: s1 source: SPECIFIC_NUMBERS acceptEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get the User’s Selective Call Accept Criteria List operationId: getUserSelectiveCallAcceptCriteriaList description: 'Retrieve selective call accept criteria list for a user. With the selective call accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update User’s Selective Call Accept Criteria operationId: updateUserSelectiveCallAcceptCriteria description: 'Modify selective call accept setting for a user. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/SelectiveAcceptCallSettingPatch' /telephony/config/people/{personId}/selectiveAccept/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Criteria to the User’s Selective Call Accept Service operationId: createCriteriaToUserSelectiveCallAcceptService description: 'Add a criteria to the user''s selective call accept service. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: scheduleName: demo_schedule1 scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19867512341' - '+19867512345' acceptEnabled: true schema: $ref: '#/components/schemas/SelectiveAcceptCallCriteriaPost' /telephony/config/people/{personId}/selectiveAccept/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveAcceptCallCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI scheduleName: demo_schedule1 scheduleType: holidays scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+19867512341' - '+19867512345' acceptEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Criteria for the User’s Selective Call Accept Service operationId: getCriteriaForUserSelectiveCallAcceptService description: 'Get the criteria details for the user''s selective call accept service. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Criteria From the User’s Selective Call Accept Service operationId: modifyCriteriaFromUserSelectiveCallAcceptService description: 'Modify a criteria for the user''s selective call accept service. With the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: scheduleName: demo_schedule1 scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: ANY_PHONE_NUMBER acceptEnabled: true schema: $ref: '#/components/schemas/SelectiveAcceptCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Criteria From the User’s Selective Call Accept service operationId: deleteCriteriaFromUserSelectiveCallAcceptService description: 'Delete a criteria from the user''s selective call accept criteria list. With the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/selectiveReject: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveRejectCallGet' example: enabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI scheduleName: demo_schedule source: ALL_NUMBERS rejectEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get the User’s Selective Call Rejection Criteria Listing operationId: getUserSelectiveCallRejectionCriteriaListing description: 'Retrieve selective call rejection criteria for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update User’s Selective Call Rejection Criteria List operationId: updateUserSelectiveCallRejectionCriteriaList description: 'Modify selective call rejection setting for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: enabled: false schema: $ref: '#/components/schemas/SelectiveRejectCallSettingPatch' /telephony/config/people/{personId}/selectiveReject/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Criteria to the User’s Selective Call Rejection Service operationId: createCriteriaToUserSelectiveCallRejectionService description: 'Add a criteria to the user''s selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: scheduleName: demo_schedule scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: true unavailableCallersEnabled: true phoneNumbers: - '+12056350001' rejectEnabled: true schema: $ref: '#/components/schemas/SelectiveRejectCallCriteriaPost' /telephony/config/people/{personId}/selectiveReject/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveRejectCallCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA5NzY3ODMzNzM scheduleName: demo_schedule scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: FORWARDED anonymousCallersEnabled: false unavailableCallersEnabled: false rejectEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Criteria for the User’s Selective Call Rejection Service operationId: getCriteriaForUserSelectiveCallRejectionService description: 'Get a criteria for the user''s selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Criteria for the User’s Selective Call Rejection Service operationId: modifyCriteriaForUserSelectiveCallRejectionService description: 'Modify a criteria for the user''s selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: scheduleName: demo_schedule scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: FORWARDED anonymousCallersEnabled: false unavailableCallersEnabled: true phoneNumbers: - '+12056350001' rejectEnabled: false schema: $ref: '#/components/schemas/SelectiveRejectCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Criteria From the User’s Selective Call Rejection Service operationId: deleteCriteriaFromUserSelectiveCallRejectionService description: 'Delete a criteria from the user''s selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/selectiveForward: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveForwardCallGet' example: enabled: true defaultPhoneNumberToForward: '+18765432190' ringReminderEnabled: true sendToVoicemailEnabled: true criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI scheduleName: demo_schedule source: ALL_NUMBERS forwardEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get the User’s Selective Call Forwarding operationId: getUserSelectiveCallForwarding description: 'Retrieve selective call forwarding criteria for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update User’s Selective Call Forwarding Criteria List operationId: updateUserSelectiveCallForwardingCriteriaList description: 'Modify selective call forwarding setting for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: enabled: false defaultPhoneNumberToForward: '+18765432192' ringReminderEnabled: false sendToVoicemailEnabled: false schema: $ref: '#/components/schemas/SelectiveForwardCallSettingPatch' /telephony/config/people/{personId}/selectiveForward/criteria: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the newly created criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Criteria to the User’s Selective Call Forwarding Service operationId: createCriteriaToUserSelectiveCallForwardingService description: 'Add a criteria to the user''s selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: schema: $ref: '#/components/schemas/SelectiveForwardCallCriteriaPost' /telephony/config/people/{personId}/selectiveForward/criteria/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectiveForwardCallCriteriaGet' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Criteria for the User’s Selective Call Forwarding Service operationId: getCriteriaForUserSelectiveCallForwardingService description: 'Get the criteria details for the user''s selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a Criteria for the User’s Selective Call Forwarding Service operationId: modifyCriteriaForUserSelectiveCallForwardingService description: 'Modify a criteria for the user''s selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: example: forwardToPhoneNumber: '+19867512340' sendToVoicemailEnabled: false scheduleName: demo_schedule1 scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: ANY_PHONE_NUMBER anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+19867512341' - '+19867512345' forwardEnabled: false schema: $ref: '#/components/schemas/SelectiveForwardCallCriteriaPatch' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Criteria From the User’s Selective Call Forwarding Service operationId: deleteCriteriaFromUserSelectiveCallForwardingService description: 'Delete a criteria from the user''s selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who''s calling, and/or the time and day of the call. Requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I schema: type: string minLength: 1 maxLength: 128 - name: id in: path description: Criteria ID. required: true example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI schema: type: string minLength: 1 maxLength: 128 - name: orgId in: query description: Organization in which the user resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/applications/availableMembers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplicationAvailableSharedLineMemberList' example: members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE firstName: John lastName: Doe phoneNumber: '1234567890' extension: '0000' routingPrefix: '1234' esn: '12348080' lineType: SHARED_CALL_APPEARANCE location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw name: MainOffice '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Search Shared-Line Appearance Members New operationId: searchSharedLineAppearanceMembersNew description: 'Get members available for shared-line assignment to a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application. This API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 - name: max in: query description: Limit the number of objects returned to this maximum count. example: 5 schema: type: number minimum: 0 - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: 0 schema: type: number minimum: 0 - name: order in: query description: Order the Route Lists according to number, ascending or descending. example: number-asc|number-desc schema: type: string minLength: 1 maxLength: 128 - name: location in: query description: Location ID for the user. example: Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy schema: type: string minLength: 1 maxLength: 128 - name: name in: query description: Search for users with names that match the query. example: abcd schema: type: string minLength: 1 maxLength: 128 - name: phoneNumber in: query description: Search for users with numbers that match the query. example: '1234567890' schema: type: string minLength: 1 maxLength: 128 - name: extension in: query description: Search for users with extensions that match the query. example: '8765' schema: type: string minLength: 1 maxLength: 128 /telephony/config/people/{personId}/applications/availableMembers/count: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - totalCount properties: totalCount: type: integer example: 100 description: The total count of available shared-line members. example: totalCount: 100 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Count of Shared-Line Appearance Members operationId: getCountOfSharedLineAppearanceMembersNew description: 'Get the count of members available for shared-line assignment to Webex Calling Apps. Shared-line appearance allows multiple devices or applications to share a single line for call handling. This API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Location ID for the person. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2ViYTgzY2VjLThiMDUtNDMxNS1iNzJlLTQ1MTUyYTg1ZWE0Yw schema: type: string - name: memberName in: query description: Search for people with names that match the query. example: john schema: type: string - name: phoneNumber in: query description: Search for people with numbers that match the query. example: '1234567890' schema: type: string - name: extension in: query description: Search for people with extensions that match the query. example: '1111' schema: type: string /telephony/config/people/{personId}/applications/members: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetSharedLineMemberList' example: model: Business Communicator - PC members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE firstName: John lastName: Doe phoneNumber: '2056852221' extension: '1111' routingPrefix: '1234' esn: '12341111' port: 1 primaryOwner: 'true' lineType: SHARED_CALL_APPEARANCE lineWeight: 1 hostIP: 198.168.0.1 remoteIP: 198.168.0.2 hotlineEnabled: true hotlineDestination: '1234' allowCallDeclineEnabled: true lineLabel: share line label memberType: PEOPLE location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw name: MainOffice maxLineCount: 10 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Shared-Line Appearance Members New operationId: getSharedLineAppearanceMembersNew description: 'Get primary and secondary members assigned to a shared line on a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application. This API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Put Shared-Line Appearance Members New operationId: putSharedLineAppearanceMembersNew description: 'Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application. This API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string minLength: 1 maxLength: 128 requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationPutSharedLineMemberList' /telephony/config/people/{personId}/callCaptions: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserCallCaptionsObject' example: userClosedCaptionsEnabled: true userTranscriptsEnabled: true locationClosedCaptionsEnabled: true locationTranscriptsEnabled: true useLocationSettingsEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get the user call captions settings operationId: getUserCallCaptionsSettings description: 'Retrieve the user''s call captions settings. **NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting. This API requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update the user call captions settings operationId: modifyUserCallCaptionsSettings description: 'Update the user''s call captions settings. **NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting. This API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: userClosedCaptionsEnabled: true userTranscriptsEnabled: true useLocationSettingsEnabled: true schema: $ref: '#/components/schemas/UpdateUserCallCaptionsObject' /telephony/config/people/{personId}/executive/callFiltering: get: responses: '200': description: The person executive call filtering settings were retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveCallFilteringGet' example: enabled: true filterType: CUSTOM_CALL_FILTERS criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1FtVjNORE15TXc9PQ filterName: VIP Callers source: SELECT_PHONE_NUMBERS activationEnabled: true filterEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Call Filtering Settings operationId: getPersonExecutiveCallFilteringSettings description: 'Retrieve the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: The executive call filtering settings were modified successfully. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Person Executive Call Filtering Settings operationId: updatePersonExecutiveCallFilteringSettings description: 'Update the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true filterType: CUSTOM_CALL_FILTERS criteriaActivation: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 activationEnabled: true schema: $ref: '#/components/schemas/ExecutiveCallFilteringPatch' /telephony/config/people/{personId}/executive/callFiltering/criteria/{id}: get: responses: '200': description: The person executive call filtering criteria was retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveCallFilteringCriteriaGet' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 filterName: VIP Callers scheduleName: Business Hours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+14085551234' - '+14085551235' filterEnabled: true callsToNumbers: - type: PRIMARY phoneNumber: '+14085556789' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Call Filtering Criteria Settings operationId: getPersonExecutiveCallFilteringCriteria description: 'Retrieve the executive call filtering criteria settings for the specified person. Executive Call Filtering Criteria in Webex allows you to retrieve the detailed configuration for a specific filter rule. This includes schedule settings, phone number filters, and call routing preferences for executive call filtering. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: id in: path required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 description: The `id` parameter specifies the unique identifier for the executive call filtering criteria. - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: The executive call filtering criteria was updated successfully. headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Person Executive Call Filtering Criteria Settings operationId: updatePersonExecutiveCallFilteringCriteria description: 'Update the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls. This API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: id in: path required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 description: 'The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`.' - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: scheduleName: Business Hours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+14085551234' - '+14085551235' filterEnabled: true callsToNumbers: - type: PRIMARY phoneNumber: '+14085556789' schema: $ref: '#/components/schemas/ExecutiveCallFilteringCriteriaPatch' delete: summary: Delete Person Executive Call Filtering Criteria operationId: deletePersonExecutiveCallFilteringCriteria description: 'Delete a specific executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier. This API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: id in: path required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 description: 'The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`.' - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string responses: '204': description: The executive call filtering criteria was deleted successfully. No content is returned. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '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/{personId}/executive/callFiltering/criteria: post: summary: Add Person Executive Call Filtering Criteria operationId: createPersonExecutiveCallFilteringCriteria description: 'Create a new executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls. This API creates a new filter rule with the specified configuration, including schedule, phone numbers, and call routing preferences. This API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the user. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecutiveCallFilteringCriteriaPost' example: filterName: VIP Callers scheduleName: Business Hours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+14085551234' - '+14085551235' filterEnabled: true callsToNumbers: - type: PRIMARY phoneNumber: '+14085556789' responses: '200': description: The executive call filtering criteria were created successfully. The response contains the new criteria identifier. content: application/json: schema: $ref: '#/components/schemas/ResponseId' example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '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/{personId}/executive/alert: get: responses: '200': description: Person executive alert settings retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAlertGet' example: alertingMode: SEQUENTIAL nextAssistantNumberOfRings: 3 rolloverEnabled: true rolloverAction: VOICE_MESSAGING rolloverForwardToPhoneNumber: '+14085267209' rolloverWaitTimeInSecs: 60 clidNameMode: EXECUTIVE_ORIGINATOR customCLIDName: John Anderson customCLIDNameInUnicode: John Anderson clidPhoneNumberMode: EXECUTIVE customCLIDPhoneNumber: '+14085267208' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '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).' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Get Person Executive Alert Settings operationId: getPersonExecutiveAlertSettings description: 'Get executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren''t answered. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: Person executive alert settings modified successfully. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '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).' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Modify Person Executive Alert Settings operationId: updatePersonExecutiveAlertSettings description: 'Update executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren''t answered. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: alertingMode: SEQUENTIAL nextAssistantNumberOfRings: 3 rolloverEnabled: true rolloverAction: VOICE_MESSAGING rolloverForwardToPhoneNumber: '' rolloverWaitTimeInSecs: 60 clidNameMode: EXECUTIVE_ORIGINATOR customCLIDName: John Anderson customCLIDNameInUnicode: John Anderson clidPhoneNumberMode: EXECUTIVE customCLIDPhoneNumber: '' schema: $ref: '#/components/schemas/ExecutiveAlertPut' /telephony/config/people/{personId}/executive/assignedAssistants: get: responses: '200': description: Person assigned assistants retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAssignedAssistantsGet' example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Assigned Assistants operationId: getPersonExecutiveAssignedAssistants description: 'Get list of assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: Person assigned assistants updated successfully. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Person Executive Assigned Assistants operationId: modifyPersonExecutiveAssignedAssistants description: 'Update assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: assistantIds: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMzRmNjdhNS1kYTFiLTQxYzUtODBkNS03ZDFmZTY3ZTE5ZTY schema: $ref: '#/components/schemas/ExecutiveAssignedAssistantsPutRequestObject' /telephony/config/people/{personId}/executive/availableAssistants: get: responses: '200': description: List of available assistants retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAvailableAssistantsGet' example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Available Assistants operationId: getPersonExecutiveAvailableAssistants description: 'Retrieves a list of people available for assignment as executive assistants to the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: 5 schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: 2 schema: type: number - name: name in: query description: Only return people with the matching name (person's first and last name combination). example: Mathew - Test schema: type: string - name: phoneNumber in: query description: Only return people with the matching phone number or extension. example: '9705550028' schema: type: string /telephony/config/people/{personId}/executive/assistant: get: responses: '200': description: Executive assistant settings were retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAssistantSettingsGet' example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+14155551234' executives: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: '+916557765419' extension: '10079' optInEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Assistant Settings operationId: getPersonExecutiveAssistantSettings description: 'Get executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: Person executive assistant settings updated successfully. headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Person Executive Assistant Settings operationId: modifyPersonExecutiveAssistantSettings description: 'Update executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+19075552860' executives: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true schema: $ref: '#/components/schemas/ExecutiveAssistantSettingsPut' /telephony/config/people/{personId}/executive/screening: get: responses: '200': description: Person executive screening settings retrieved successfully. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveScreeningGet' example: enabled: true alertType: SILENT alertAnywhereLocationEnabled: false alertMobilityLocationEnabled: false alertSharedCallAppearanceLocationEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Person Executive Screening Settings operationId: getPersonExecutiveScreeningSettings description: 'Get executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications. This API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: Person executive screening settings modified successfully. '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Person Executive Screening Settings operationId: updatePersonExecutiveScreeningSettings description: 'Update executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications. This API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: A unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ schema: type: string - name: orgId in: query description: Organization ID for the person. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: false alertType: RING_SPLASH alertAnywhereLocationEnabled: false alertMobilityLocationEnabled: false alertSharedCallAppearanceLocationEnabled: false schema: $ref: '#/components/schemas/ExecutiveScreeningPut' /telephony/config/people/{personId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetPersonDetailsObject' example: announcementLanguage: English timeZone: America/Chicago '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Timezone and Announcement Language Settings of a Person operationId: getTimezoneAnnouncementLanguageSettingsOfAPerson description: 'Retrieve a person''s timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Retrieve timezone and announcement language settings of this person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY schema: type: string - name: orgId in: query description: Organization ID. If not specified, uses the organization from the OAuth token. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Timezone and Announcement Language Settings of a Person operationId: modifyTimezoneAnnouncementLanguageSettingsOfAPerson description: 'Modify a person''s timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - User Call Settings (2/2) parameters: - name: personId in: path description: Modify timezone and announcement language settings of this person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY schema: type: string - name: orgId in: query description: Organization ID. If not specified, uses the organization from the OAuth token. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: announcementLanguage: English timeZone: America/Chicago schema: $ref: '#/components/schemas/PutPersonDetailsObject' /telephony/config/countries/{countryCode}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CountryConfigGet' example: stateRequired: true zipCodeRequired: true states: - code: AA name: Armed Forces Americas - code: AE name: Armed Forces Europe - code: WY name: Wyoming timeZones: - America/Adak - America/Anchorage - America/Chicago - America/Denver - America/Los_Angeles - America/New_York - America/Phoenix - Pacific/Honolulu '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Country Calling Configuration operationId: getCountryConfiguration description: 'Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones. This information helps administrators configure user settings with valid timezone and location data for a specific country. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - User Call Settings (2/2) parameters: - name: countryCode in: path description: The ISO country code to retrieve configuration for. required: true example: US schema: type: string - name: orgId in: query description: Organization ID. If not specified, uses the organization from the OAuth token. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string components: schemas: PersonFaxMessageAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. Assistant: type: object description: Details of an executive assistant. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John phoneNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg required: - id - optInEnabled - location properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU description: Unique identifier of the assistant. firstName: type: string example: doe description: Unicode first name of the assistant. Is null if not available or if name is a single '.' or '-'. lastName: type: string example: John description: Unicode last name of the assistant. Is null if not available or if name is a single '.' or '-'. directNumber: type: string example: +91-6557765419 description: Direct number of the assistant. extension: type: string example: '10079' description: Extension number of the assistant. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. If `false`, the assistant has not opted in. location: $ref: '#/components/schemas/Location' PutMusicOnHoldObject: type: object properties: mohEnabled: type: boolean example: true description: Music on hold is enabled or disabled for the workspace. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. ExecutiveScreeningGet: type: object description: Executive screening settings response object containing configuration for call screening and alert preferences. required: - enabled - alertType - alertAnywhereLocationEnabled - alertMobilityLocationEnabled - alertSharedCallAppearanceLocationEnabled properties: enabled: type: boolean description: Indicates if executive screening is enabled. alertType: type: string enum: - SILENT - RING_SPLASH description: " * `SILENT` - No audible alert is provided for executive screening.\n * `RING_SPLASH` - A short ring (splash) is used as an alert for executive screening.\n" alertAnywhereLocationEnabled: type: boolean description: Indicates if alerts are enabled for Single Number Reach locations. alertMobilityLocationEnabled: type: boolean description: Indicates if alerts are enabled for Webex Go locations. alertSharedCallAppearanceLocationEnabled: type: boolean description: Indicates if alerts are enabled for Shared Call Appearance locations. example: enabled: true alertType: SILENT alertAnywhereLocationEnabled: false alertMobilityLocationEnabled: false alertSharedCallAppearanceLocationEnabled: false SourceForSelectiveForward: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ALL_NUMBERS` - Criteria applies to all incoming numbers.\n * `SPECIFIC_NUMBERS` - Criteria applies only for specific incoming numbers.\n * `ANY_INTERNAL` - Criteria applies to all internal incoming numbers.\n * `ANY_EXTERNAL` - Criteria applies to all external incoming numbers.\n" PutSharedLineMemberList: type: object properties: members: type: array items: $ref: '#/components/schemas/PutSharedLineMemberItem' VoiceMailPartyInformation: type: object required: - privacyEnabled properties: name: type: string example: John Smith description: The party's name. Only present when the name is available and privacy is not enabled. number: type: string example: '+12223334444' description: 'The party''s number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`, `+12223334444`, `*73`, and `user@company.domain`.' personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg= description: The party's person ID. Only present when the person ID is available and privacy is not enabled. placeId: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ3MWEyLTRlOTItOTFhYi05ZjJmLWJjYTEzNTAxM2ExNA== description: The party's place ID. Only present when the place ID is available and privacy is not enabled. privacyEnabled: type: boolean description: if `true`, denotes privacy is enabled for the name, number and `personId`/`placeId`. UserOutgoingPermissionDigitPatternGetListObject: type: object required: - useCustomDigitPatterns - digitPatterns properties: useCustomDigitPatterns: type: boolean description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. digitPatterns: type: array items: $ref: '#/components/schemas/UserDigitPatternObject' description: List of digit patterns. SelectiveAcceptCallGet: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Selective Accept feature is enabled.' criteria: type: array items: $ref: '#/components/schemas/SelectiveAcceptCallCriteria' description: A list of criteria specifying conditions when selective accept is in effect. PutSharedLineMemberItem: type: object required: - id - port - primaryOwner - lineType - lineWeight - hotlineEnabled - hotlineDestination - allowCallDeclineEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE description: Unique identifier for the person or workspace. port: type: number example: 1 description: Device port number assigned to person or workspace. t38FaxCompressionEnabled `true`: type: boolean description: T.38 Fax Compression setting. Valid only for ATA Devices. Overrides user level compression options. primaryOwner: type: string example: 'true' description: If `true` the person or the workspace is the owner of the device. Points to primary line/port of the device. lineType: $ref: '#/components/schemas/LineType' description: If the line is acting as a primary line or a shared line for this device. lineWeight: type: number minimum: 1 example: 1 description: Number of lines that have been configured for the person on the device. hotlineEnabled: type: boolean example: true description: Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in `hotlineDestination`. hotlineDestination: type: string example: '1234' description: Preconfigured number for the hotline. Required only if `hotlineEnabled` is set to `true`. allowCallDeclineEnabled: type: boolean example: true description: Set how a device behaves when a call is declined. When set to `true`, a call decline request is extended to all the endpoints on the device. When set to `false`, a call decline request is only declined at the current endpoint. lineLabel: type: string example: share line label description: Device line label. ErrorObject: type: object properties: key: type: string description: HTTP error code. message: type: array items: $ref: '#/components/schemas/ErrorMessageObject' description: Message string with further error information. GetSharedLineMemberList: type: object required: - model - maxLineCount properties: model: type: string example: Business Communicator - PC description: Model name of device. members: type: array items: $ref: '#/components/schemas/GetSharedLineMemberItem' description: List of members. maxLineCount: type: number minimum: 1 example: 10 description: Maximum number of device ports. ModifyUserMSTeamsSettingsObject: type: object required: - settingName - value properties: settingName: type: string enum: - HIDE_WEBEX_APP description: "The enum value to be set to `HIDE_WEBEX_APP`.\n * `HIDE_WEBEX_APP` - Webex will continue to run but its windows will be closed by default. Users can still access Webex from the system tray on Windows or the Menu Bar on Mac.\n" value: type: boolean example: true description: The boolean value to update the `HIDE_WEBEX_APP` setting, either `true` or `false`. Set to `null` to delete the `HIDE_WEBEX_APP` setting. GetPersonDetailsObject: type: object required: - announcementLanguage - timeZone example: announcementLanguage: English timeZone: America/Los_Angeles properties: announcementLanguage: type: string example: English description: Person's phone announcement language. timeZone: type: string example: America/Los_Angeles description: Timezone associated with the person for calling package. Refer to the Get Country Configuration API to retrieve the list of available timezones for a specific country. SelectiveRejectCallSettingPatch: type: object required: - enabled properties: enabled: type: boolean description: if `true`, selective reject is enabled. UserOutgoingPermissionDigitPatternCategoryControlPatchObject: type: object properties: useCustomDigitPatterns: type: boolean example: true description: When `true`, use custom settings for the digit patterns category of outgoing call permissions. AvailableSharedLineMemberList: type: object properties: members: type: array items: $ref: '#/components/schemas/AvailableSharedLineMemberItem' PersonECBNAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which phone number is assigned. type: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - HUNT_GROUP description: "Type of the PSTN phone number's owner.\n * `PLACE` - Phone number's owner is a workspace.\n * `PEOPLE` - Phone number's owner is a person.\n * `VIRTUAL_LINE` - Phone number's owner is a Virtual Line.\n * `HUNT_GROUP` - Phone number's owner is a Hunt Group.\n" firstName: type: string example: Test description: First name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the phone number's owner. This field will be present only when the owner `type` is `PLACE` or `HUNT_GROUP`. PersonalAssistantPatch: type: object properties: enabled: type: boolean example: true description: Toggles feature. presence: type: string enum: - NONE - BUSINESS_TRIP - GONE_FOR_THE_DAY - LUNCH - MEETING - OUT_OF_OFFICE - TEMPORARILY_OUT - TRAINING - UNAVAILABLE - VACATION description: "Person's availability.\n * `NONE` - User is available.\n * `BUSINESS_TRIP` - User is gone for a business trip.\n * `GONE_FOR_THE_DAY` - User is gone for the day.\n * `LUNCH` - User is gone for lunch.\n * `MEETING` - User is gone for a meeting.\n * `OUT_OF_OFFICE` - User is out of office.\n * `TEMPORARILY_OUT` - User is temporarily out.\n * `TRAINING` - User is gone for training.\n * `UNAVAILABLE` - User is unavailable.\n * `VACATION` - User is gone for vacation.\n" untilDateTime: type: string example: '2022-08-24T06:18:31.092Z' description: The date until which the personal assistant is active. transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. transferNumber: type: string example: '+14126525012' description: Number to transfer to. alerting: type: string enum: - ALERT_ME_FIRST - PLAY_RING_REMINDER - NONE description: "Alert type.\n * `ALERT_ME_FIRST` - Ring the recipient first.\n * `PLAY_RING_REMINDER` - Ring reminder for the recipient.\n * `NONE` - No alert.\n" alertMeFirstNumberOfRings: type: number example: 3 description: 'Number of rings for alert type: ALERT_ME_FIRST; available range is 2-20.' SelectiveAcceptCallCriteriaPatch: type: object required: - callsFrom - acceptEnabled 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/CallsFromSelectiveAccept' description: Accept calls from selected. 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. acceptEnabled: type: boolean example: true description: Boolean flag to enable/disable the selective accept criteria. UsersListItem: type: object required: - locationId - validate - users properties: locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA description: Target location for the user moves. validate: type: boolean description: Set to `true` to validate the user move; this option is not supported for multiple users. Set to `false` to perform the user move. users: type: array items: $ref: '#/components/schemas/UserItem' description: List of users to be moved. ExecutiveCallFilteringGet: type: object description: Executive call filtering settings response object that contains the filter configuration and criteria. required: - enabled - filterType properties: enabled: type: boolean description: Indicates whether executive call filtering is enabled. filterType: type: string enum: - CUSTOM_CALL_FILTERS - ALL_CALLS - ALL_INTERNAL_CALLS - ALL_EXTERNAL_CALLS description: " * `CUSTOM_CALL_FILTERS` - Choose this option to ensure that only specific calls are sent to the executive assistant.\n * `ALL_CALLS` - Choose this option to send both internal and external calls to the executive assistant.\n * `ALL_INTERNAL_CALLS` - Choose this option to send all internal calls to the executive assistant.\n * `ALL_EXTERNAL_CALLS` - Choose this option to send all external calls to the executive assistant.\n" criteria: type: array description: The list of call filtering criteria configured for executive call filtering. items: type: object description: The configuration for an individual call filtering criterion. required: - id - filterName - source - activationEnabled - filterEnabled properties: id: type: string description: Unique identifier for the filter criteria. filterName: type: string description: Name of the criteria. source: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n * `ANY_INTERNAL` - The criteria applies to any internal number.\n * `ANY_EXTERNAL` - The criteria applies to any external number.\n" activationEnabled: type: boolean description: Controls whether this filter criteria is active. When `true`, the criteria is evaluated for incoming calls. When `false`, the criteria is completely ignored and has no effect on call filtering. filterEnabled: type: boolean description: Controls the action when this criteria matches a call. When `true`, matching calls are filtered and will alert the executive's assistants. When `false`, matching calls are not filtered and will not alert the executive's assistants. Criteria with `filterEnabled` as `false` take precedence over other filtering criteria with `filterEnabled` as `true`, allowing exceptions where certain calls are not filtered to the executive's assistants. example: enabled: true filterType: CUSTOM_CALL_FILTERS criteria: - id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1FtVjNORE15TXc9PQ filterName: VIP Callers source: SELECT_PHONE_NUMBERS activationEnabled: true filterEnabled: true MoveUsersValidationResponse: type: object required: - response properties: response: type: array items: $ref: '#/components/schemas/UserListItem' description: Contains the response for the user moves validation. ExecutiveCallFilteringCriteriaPost: type: object description: Executive call filtering criteria settings request object for updating detailed filter rules and routing configuration. required: - filterName - callsFrom - filterEnabled properties: filterName: type: string description: Name of the criteria. scheduleName: type: string description: Name of the schedule associated with this criteria. scheduleType: type: string enum: - holidays - businessHours 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" 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 (Location) level.\n" callsFrom: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n * `ANY_INTERNAL` - The criteria applies to any internal number.\n * `ANY_EXTERNAL` - The criteria applies to any external number.\n" anonymousCallersEnabled: type: boolean description: Set to enable or disable the criteria for anonymous callers. unavailableCallersEnabled: type: boolean description: Set to enable or disable the criteria for unavailable callers. phoneNumbers: type: array description: The list of phone numbers that this filtering criteria applies to, when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. items: type: string description: Phone number that the criteria applies to based on `callsFrom` selection. filterEnabled: type: boolean description: Controls the action when this criteria matches a call. When `true`, matching calls are filtered and will alert the executive's assistants. When `false`, matching calls are not filtered and will not alert the executive's assistants. Criteria with `filterEnabled` as `false` take precedence over other filtering criteria with `filterEnabled` as `true`, allowing exceptions where certain calls are not filtered to the executive's assistants. callsToNumbers: type: array description: List of numbers for the executive that will match the criteria when called. This may include the executive’s primary number and/or extension, as well as secondary (alternate) numbers (and associated extensions). If the list is empty, any number or extension for the executive matches the criteria when called. If the list is not empty, only the specified numbers and their extensions match the criteria. items: type: object description: Executive phone number that will match the criteria when called. properties: type: type: string enum: - PRIMARY - ALTERNATE description: " * `PRIMARY` - Number is assigned as primary to executive.\n * `ALTERNATE` - Number is assigned as alternate (secondary) to the executive.\n" phoneNumber: type: string description: The phone number assigned to the executive that will be used to match criteria. PersonCallForwardAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for a PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. StartJobExecutionStatusObject: type: object required: - id - startTime - statusMessage - createdTime properties: id: type: number example: 332387 description: Unique identifier for each instance of the job. startTime: type: string example: '2023-05-30T13:04:00.469Z' description: Start date and time of the job in UTC format. lastUpdated: type: string example: '2023-05-30T13:04:03.574Z' description: Last update date and time of the job in UTC format after a step execution completion. statusMessage: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Status for the overall steps that are part of the job.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" exitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Overall result of the job.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" createdTime: type: string example: '2023-05-30T13:04:00.457Z' description: Creation date and time of the job in UTC format. timeElapsed: type: string example: PT2.752S description: Time elapsed in seconds since the job execution started. UserType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: " * `PEOPLE` - The associated member is a person.\n * `PLACE` - The associated member is a workspace.\n * `VIRTUAL_LINE` - The associated member is a virtual line.\n" EndpointIdType: type: object required: - preferredAnswerEndpointId properties: preferredAnswerEndpointId: type: string example: Y2lzY29z... description: Person’s preferred answer endpoint. nullable: true ErrorOrImpactItem: type: object required: - code - message properties: code: type: number example: 1026016 description: Error or Impact code. message: type: string example: User should have either phone number or extension. description: Message string with more error or impact information. DeviceType: type: string enum: - DEVICE - APPLICATION description: " * `DEVICE` - The endpoint is a device.\n * `APPLICATION` - The endpoint is a application.\n" NumberOwnerType: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - AUTO_ATTENDANT - CALL_QUEUE - GROUP_PAGING - HUNT_GROUP - VOICE_MESSAGING - OFFICE_ANYWHERE - CONTACT_CENTER_LINK - CONTACT_CENTER_ADAPTER - ROUTE_LIST - VOICEMAIL_GROUP - COLLABORATE_BRIDGE description: " * `PLACE` - PSTN phone number's owner is a workspace.\n * `PEOPLE` - PSTN phone number's owner is a person.\n * `VIRTUAL_LINE` - PSTN phone number's owner is a Virtual Profile.\n * `AUTO_ATTENDANT` - PSTN phone number's owner is an auto-attendant.\n * `CALL_QUEUE` - PSTN phone number's owner is a call queue.\n * `GROUP_PAGING` - PSTN phone number's owner is a group paging.\n * `HUNT_GROUP` - PSTN phone number's owner is a hunt group.\n * `VOICE_MESSAGING` - PSTN phone number's owner is a voice messaging.\n * `OFFICE_ANYWHERE` - PSTN phone number's owner is a Single Number Reach.\n * `CONTACT_CENTER_LINK` - PSTN phone number's owner is a Contact Center link.\n * `CONTACT_CENTER_ADAPTER` - PSTN phone number's owner is a Contact Center adapter.\n * `ROUTE_LIST` - PSTN phone number's owner is a route list.\n * `VOICEMAIL_GROUP` - PSTN phone number's owner is a voicemail group.\n * `COLLABORATE_BRIDGE` - PSTN phone number's owner is a collaborate bridge.\n" UserModeManagementFeatureObject: type: object required: - id - name - type - modeBasedForwardingEnabled - exceptionType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ description: A unique identifier for the feature. name: type: string example: Test Feature description: Unique name for the feature. type: $ref: '#/components/schemas/ModeManagementFeatureTypeObject' description: Defines the scheduling of the operating mode. phoneNumber: type: string example: '+19705550028' description: The primary phone number configured for the feature. extension: type: string example: 0028 description: The extension configured for the feature. modeBasedForwardingEnabled: type: boolean example: true description: A flag to indicate whether mode-based call forwarding is enabled for the feature. forwardDestination: type: string example: '+19705550028' description: The destination for call forwarding if mode-based call forwarding is enabled. currentOperatingModeName: type: string example: Day Operating Mode description: Name of the current operating mode. currentOperatingModeId: type: string example: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzIxM2I1ZTIwLTljMjAtNDUwNi1iYWE3LTE0OGE0NWQyZWY4OQ description: Unique identifier for the current operating mode. exceptionType: $ref: '#/components/schemas/ExceptionTypeObject' description: Defines the exception through which the current operating mode is set as active for the feature. location: $ref: '#/components/schemas/location' description: Location object that has a unique identifier for the location and its name. GetMusicOnHoldObject: type: object required: - mohEnabled - mohLocationEnabled - greeting properties: mohEnabled: type: boolean example: true description: Music on hold enabled or disabled for the workspace. mohLocationEnabled: type: boolean example: true description: Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is false and `mohEnabled` is true, music on hold is disabled for the workspace. When `mohLocationEnabled` is true and `mohEnabled` is false, music on hold is turned off for the workspace. In both cases, music on hold will not be played. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileGetObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. UserOutgoingPermissionDigitPatternPatchObject: type: object properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. StartJobResponseObject: type: object required: - name - id - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - counts properties: name: type: string example: moveusers description: Job name. id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk description: Unique identifier of the job. trackingId: type: string example: ROUTER_ebb52b5b-d060-4164-9757-48b383423d73 description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY description: Unique identifier of the user who ran the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier of the customer who ran the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier of the customer for whom the job was run. instanceId: type: number example: 10 description: Unique identifier of the job instance. jobExecutionStatus: type: array items: $ref: '#/components/schemas/StartJobExecutionStatusObject' description: Most recent step's execution status, including statuses of all steps in the job execution. latestExecutionStatus: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Most recent status of the job at the time of invocation.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" counts: $ref: '#/components/schemas/CountObject' description: Statistics of the job. SelectiveForwardCallCriteriaPost: type: object required: - forwardToPhoneNumber - sendToVoicemailEnabled - callsFrom properties: forwardToPhoneNumber: type: string example: '+18898988831' description: Number to which calls needs to be forwarded. sendToVoicemailEnabled: type: boolean description: Boolean flag to enable/disable sending calls to voicemail. 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 type of schedule. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFromSelectiveReject' description: Reject calls selection. anonymousCallersEnabled: type: boolean example: true description: Calls From custom numbers, private number enabled. unavailableCallersEnabled: type: boolean example: true description: Calls From custom numbers, unavailable number 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. forwardEnabled: type: boolean example: true description: Boolean flag to enable/disable selective call forward. ErrorResponseObject: type: object properties: items: type: array items: $ref: '#/components/schemas/ItemObject' UserPlaceAuthorizationCodeListGet: type: object required: - accessCodes properties: accessCodes: type: array items: $ref: '#/components/schemas/AuthorizationCode' description: The set of activation codes and description. UserModeManagementAvailableFeaturesObject: type: object required: - id - name - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ description: A unique identifier for the feature. name: type: string example: Test Feature description: Unique name for the feature. type: $ref: '#/components/schemas/ModeManagementFeatureTypeObject' description: Defines the scheduling of the operating mode. phoneNumber: type: string example: '+19705550028' description: The primary phone number configured for the feature. extension: type: string example: 0028 description: The extension configured for the feature. AudioAnnouncementFileGetObject: type: object required: - id - fileName - mediaFileType - level properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" 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. PersonSecondaryAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. AvailableAssistant: type: object description: Details of person available to be assigned as executive assistant. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU description: Unique identifier of the person. firstName: type: string example: doe description: Unicode first name of the person. Is null if not available or if name is a single '.' or '-'. lastName: type: string example: John description: Unicode last name of the person. Is null if not available or if name is a single '.' or '-'. directNumber: type: string example: +91-6557765419 description: Direct number of the person. extension: type: string example: '10079' description: Extension number of the person. CallBridgePut: type: object properties: warningToneEnabled: type: boolean description: Set to enable or disable a stutter dial tone being played to all the participants when a virtual line is bridged on the active shared line call. ExecutiveCallFilteringCriteriaPatch: type: object description: Executive call filtering criteria settings request object for updating detailed filter rules and routing configuration. properties: scheduleName: type: string description: Name of the schedule associated with this criteria. scheduleType: type: string enum: - holidays - businessHours 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" 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 (Location) level.\n" callsFrom: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n * `ANY_INTERNAL` - The criteria applies to any internal number.\n * `ANY_EXTERNAL` - The criteria applies to any external number.\n" anonymousCallersEnabled: type: boolean description: Set to enable or disable the criteria for anonymous callers. unavailableCallersEnabled: type: boolean description: Set to enable or disable the criteria for unavailable callers. phoneNumbers: type: array description: The list of phone numbers that this filtering criteria applies to, when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. items: type: string description: Phone number that the criteria applies to based on `callsFrom` selection. filterEnabled: type: boolean description: Controls the action when this criteria matches a call. When `true`, matching calls are filtered and will alert the executive's assistants. When `false`, matching calls are not filtered and will not alert the executive's assistants. Criteria with `filterEnabled` as `false` take precedence over other filtering criteria with `filterEnabled` as `true`, allowing exceptions where certain calls are not filtered to the executive's assistants. callsToNumbers: type: array description: List of numbers for the executive that will match the criteria when called. This may include the executive’s primary number and/or extension, as well as secondary (alternate) numbers (and associated extensions). If the list is empty, any number or extension for the executive matches the criteria when called. If the list is not empty, only the specified numbers and their extensions match the criteria. items: type: object description: Executive phone number that will match the criteria when called. properties: type: type: string enum: - PRIMARY - ALTERNATE description: " * `PRIMARY` - Number is assigned as primary to executive.\n * `ALTERNATE` - Number is assigned as alternate (secondary) to the executive.\n" phoneNumber: type: string description: The phone number assigned to the executive that will be used to match criteria. 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. GetUserCallCaptionsObject: type: object required: - userClosedCaptionsEnabled - userTranscriptsEnabled - locationClosedCaptionsEnabled - locationTranscriptsEnabled - useLocationSettingsEnabled properties: userClosedCaptionsEnabled: type: boolean example: true description: User-level closed captions are enabled or disabled. userTranscriptsEnabled: type: boolean example: true description: User-level transcripts are enabled or disabled. locationClosedCaptionsEnabled: type: boolean example: true description: Location closed captions are enabled or disabled. If `useOrgSettingsEnabled` is `true`, these are organization-level settings. Otherwise, location-level settings are used. locationTranscriptsEnabled: type: boolean example: true description: Location transcripts are enabled or disabled. If `useOrgSettingsEnabled` is `true`, these are organization-level settings. Otherwise, location-level settings are used. useLocationSettingsEnabled: type: boolean example: true description: If `useLocationSettingsEnabled` is `true`, location settings will control the user's closed captions and transcripts. Otherwise, user-level settings are used. Action: type: string enum: - ADD - DELETE description: " * `ADD` - Add action.\n * `DELETE` - Delete action.\n" SelectiveAcceptCallCriteriaPost: type: object required: - callsFrom - acceptEnabled 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/CallsFromSelectiveAccept' description: Accept 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. acceptEnabled: type: boolean example: true description: Boolean flag indicating if selective call accept is enabled. PersonCallInterceptAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for a PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. TransferNumberGet: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1205553650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1205553651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1205553652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. GetUserMSTeamsSettingsObject: type: object required: - personId - orgId - settings properties: personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI description: Unique identifier for the person. orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM description: Unique identifier for the organization in which the person resides. settings: type: array items: $ref: '#/components/schemas/SettingsObject' description: Array of `SettingsObject`. 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" JobExecutionStatusObject: type: object required: - id - lastUpdated - statusMessage - createdTime - timeElapsed properties: id: type: number example: 735206 description: Unique identifier that identifies each instance of the job. startTime: type: string example: '2023-05-30T13:04:00.469Z' description: The date and time with seconds, the job has started in UTC format. endTime: type: string example: '2023-05-30T13:04:03.245Z' description: The date and time with seconds, the job has ended in UTC format. lastUpdated: type: string example: '2023-05-30T13:04:03.574Z' description: The date and time with seconds, the job has last updated in UTC format post one of the step execution completion. statusMessage: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Displays status for overall steps that are part of the job.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" exitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Exit Code for a job.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" createdTime: type: string example: '2023-05-30T13:04:00.457Z' description: The date and time with seconds, the job has created in UTC format. timeElapsed: type: string example: PT2.752S description: Time lapsed in seconds since the job execution started. stepExecutionStatuses: type: array items: $ref: '#/components/schemas/stepExecutionStatusesObject' description: Status of each step within a job. ExecutiveScreeningPut: type: object description: Executive screening settings request object for updating call screening and alert preferences. properties: enabled: type: boolean description: Set to enable or disable executive screening. alertType: type: string enum: - SILENT - RING_SPLASH description: " * `SILENT` - No audible alert is provided for executive screening.\n * `RING_SPLASH` - A short ring (splash) is used as an alert for executive screening.\n" alertAnywhereLocationEnabled: type: boolean description: Indicates if alerts are enabled for Single Number Reach locations. alertMobilityLocationEnabled: type: boolean description: Indicates if alerts are enabled for Webex Go locations. alertSharedCallAppearanceLocationEnabled: type: boolean description: Indicates if alerts are enabled for Shared Call Appearance locations. example: enabled: true alertType: SILENT alertAnywhereLocationEnabled: false alertMobilityLocationEnabled: false alertSharedCallAppearanceLocationEnabled: false ApplicationsSetting: type: object required: - ringDevicesForClickToDialCallsEnabled - ringDevicesForGroupPageEnabled - ringDevicesForCallParkEnabled - browserClientEnabled - desktopClientEnabled - tabletClientEnabled - mobileClientEnabled - availableLineCount properties: ringDevicesForClickToDialCallsEnabled: type: boolean example: true description: When `true`, indicates to ring devices for outbound Click to Dial calls. ringDevicesForGroupPageEnabled: type: boolean example: true description: When `true`, indicates to ring devices for inbound Group Pages. ringDevicesForCallParkEnabled: type: boolean example: true description: When `true`, indicates to ring devices for Call Park recalled. browserClientEnabled: type: boolean example: true description: Indicates that the browser Webex Calling application is enabled for use. browserClientId: type: string example: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQyNDM3YzY5LTBlNmYtNGMxZS1iMTJhLTFjNGYxZTk5NDRjMA description: Device ID of WebRTC client. Returns only if `browserClientEnabled` is true. desktopClientEnabled: type: boolean example: true description: Indicates that the desktop Webex Calling application is enabled for use. desktopClientId: type: string example: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg description: Device ID of Desktop client. Returns only if `desktopClientEnabled` is true. tabletClientEnabled: type: boolean example: true description: Indicates that the tablet Webex Calling application is enabled for use. tabletClientId: type: string example: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg description: Device ID of Tablet client. Returns only if `tabletClientEnabled` is true. mobileClientEnabled: type: boolean example: true description: Indicates that the mobile Webex Calling application is enabled for use. mobileClientId: type: string example: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL2IwOWYzMDlhLTY0NDItNDRiYi05OGI2LWEzNTEwYjFhNTJmZg description: Device ID of Mobile client. Returns only if `mobileClientEnabled` is true. availableLineCount: type: number example: 35 description: Number of available device licenses for assigning devices/apps. description: Application services settings for a user. Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app. ExecutiveAssignedAssistantsGet: type: object description: Response object for the executive assigned assistants. example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg properties: assistants: type: array items: $ref: '#/components/schemas/Assistant' description: List of assigned executive assistants. location: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw description: Location identifier associated with the members. name: type: string example: MainOffice description: Location name associated with the member. PutPersonDetailsObject: type: object properties: announcementLanguage: type: string example: English description: Person's phone announcement language. timeZone: type: string example: America/Los_Angeles description: Timezone associated with the person for calling configuration. Refer to the Get Country Configuration API to retrieve the list of available timezones for a specific country. CallsFromSelectiveReject: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - Criteria apply for any incoming number.\n * `SELECT_PHONE_NUMBERS` - Criteria only apply for selected incoming numbers.\n * `ANY_INTERNAL` - Criteria only apply for any internal incoming numbers.\n * `ANY_EXTERNAL` - Criteria only apply for any external incoming numbers.\n" ApplicationPutSharedLineMemberList: type: object properties: members: type: array items: $ref: '#/components/schemas/ApplicationPutSharedLineMemberItem' description: List of members to be added or modified for shared-line assignment to a Webex Calling Apps. description: List of members to be added or modified for shared-line assignment to a Webex Calling Apps. RingPattern: type: string enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT description: " * `NORMAL` - Normal incoming ring pattern.\n * `LONG_LONG` - Incoming ring pattern of two long rings.\n * `SHORT_SHORT_LONG` - Incoming ring pattern of two short rings, followed by a short ring.\n * `SHORT_LONG_SHORT` - Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.\n" AvailableSharedLineMemberItem: type: object required: - id - firstName - lastName - lineType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE description: A unique member identifier. firstName: type: string example: John description: First name of member. lastName: type: string example: Doe description: Last name of member. phoneNumber: type: string example: '1234567890' description: Phone number of member. Currently, E.164 format is not supported. extension: type: string example: '0000' description: Phone extension of member. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12340000' description: Routing prefix + extension of a person or workspace. lineType: $ref: '#/components/schemas/LineType' description: If the line is acting as a primary line or a shared line for this device. location: $ref: '#/components/schemas/location' description: Location object having a unique identifier for the location and its name. CountObject: type: object required: - totalMoves - moved - failed - pending - skipped properties: totalMoves: type: number example: 100 description: Total number of user moves requested. moved: type: number example: 50 description: Total number of user moves completed successfully. failed: type: number example: 50 description: Total number of user moves that were completed with failures. pending: type: number example: 50 description: Total number of user moves that were pending with number orders. skipped: type: number example: 50 description: Total number of user moves that were skipped. ExecutiveAssistantSettingsGet: type: object description: Settings for an executive assistant. example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+14155551234' executives: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: +91-6557765419 extension: '10079' optInEnabled: true required: - forwardFilteredCallsEnabled properties: forwardFilteredCallsEnabled: type: boolean example: true description: If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`. forwardToPhoneNumber: type: string example: '6822234354' description: Phone number to forward calls to when `forwardFilteredCallsEnabled` is set to `true`. executives: type: array items: $ref: '#/components/schemas/Executive' description: List of executives for whom person is assigned as assistant. ModifyVoicemailPasscode: type: object required: - passcode properties: passcode: type: string example: '1551234' description: Voicemail access passcode. The minimum length of the passcode is 6 and the maximum length is 30. ArrayOfFeatureIdsObject: type: object required: - featureIds properties: featureIds: type: array items: type: string description: Array of feature IDs. endpoints: type: object required: - id - type - name properties: id: type: string example: Y2lzY29z... description: Unique identifier for the endpoint. type: $ref: '#/components/schemas/DeviceType' description: Enumeration that indicates if the endpoint is of type `DEVICE` or `APPLICATION`. name: type: string example: Cisco 8865 (Phone in reception area) description: The `name` field in the response is calculated using device tag. Admins have the ability to set tags for devices. If a `name=` tag is set, for example “name=home phone“, then the `` is included in the `name` field of the API response. In this example “home phone”. PersonSecondaryAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonSecondaryAvailableNumberObject' description: Array of phone numbers. SelectiveAcceptCallSource: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - FORWARDED description: " * `ALL_NUMBERS` - Selective accept criteria applies for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Selective accept criteria applies for calls from specific numbers.\n * `FORWARDED` - Selective accept criteria applies for all forwarded calls.\n" SelectiveForwardCallCriteriaPatch: type: object required: - forwardToPhoneNumber - sendToVoicemailEnabled - callsFrom properties: forwardToPhoneNumber: type: string example: '+18898988831' description: Number to which calls needs to be forwarded. sendToVoicemailEnabled: type: boolean description: Boolean flag to enable/disable sending calls to voicemail. 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 type of schedule. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: The schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFromSelectiveReject' 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. forwardEnabled: type: boolean example: true description: Boolean flag to enable/disable selective call forwarding. MoveUsersStartJobObject: type: object required: - usersList properties: usersList: type: array items: $ref: '#/components/schemas/UsersListItem' description: Specifies the users to be moved from the source location. SelectiveRejectCallGet: 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/SelectiveRejectCriteria' description: A list of criteria specifying conditions when selective reject is in effect. SelectiveForwardCallGet: type: object required: - enabled - defaultPhoneNumberToForward - ringReminderEnabled - destinationVoicemailEnabled - criteria properties: enabled: type: boolean example: true description: '`true` if the Selective Forward feature is enabled.' defaultPhoneNumberToForward: type: string example: '+1934898988' description: Enter the phone number to forward calls to during this schedule. ringReminderEnabled: type: boolean example: true description: When `true`, enables a ring reminder for such calls. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. criteria: type: array items: $ref: '#/components/schemas/SelectiveForwardCallCriteria' description: A list of criteria specifying conditions when selective forward feature is in effect. SelectiveRejectCallSource: type: string enum: - ALL_NUMBERS - SPECIFIC_NUMBERS - FORWARDED description: " * `ALL_NUMBERS` - Selective reject criteria applies for all incoming numbers.\n * `SPECIFIC_NUMBERS` - Selective reject criteria applies for calls from specific numbers.\n * `FORWARDED` - Selective reject criteria applies for all forwarded calls.\n" SelectiveAcceptCallCriteriaGet: type: object required: - callsFrom - acceptEnabled 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: Schedule Type. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: Schedule Level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFromSelectiveAccept' description: Accept 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. acceptEnabled: type: boolean example: true description: Boolean flag indicating if selective call accept is enabled. SelectiveAcceptCallSettingPatch: type: object required: - enabled properties: enabled: type: boolean description: indicates whether selective accept is enabled or not. AuthorizationCode: type: object properties: code: type: string example: '4856' description: Access code. description: type: string example: Marketing's access code description: The description of the access code. AgentCallerIdType: type: string enum: - CALL_QUEUE - HUNT_GROUP description: " * `CALL_QUEUE` - A call queue has been selected for the agent's caller ID.\n * `HUNT_GROUP` - A hunt group has been selected for the agent's caller ID.\n" Location: type: object description: Details of the location for the assigned assistant. example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore required: - name - id properties: name: type: string example: Bangalore description: Name of the location. id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg description: Unique identifier of the location. stepExecutionStatusesObject: type: object required: - id - lastUpdated - statusMessage - name - timeElapsed properties: id: type: number example: 3624681 description: Unique identifier that identifies each step in a job. startTime: type: string example: '2023-05-30T13:04:00.469Z' description: The date and time with seconds, the step execution has started in UTC format. endTime: type: string example: '2023-05-30T13:04:03.245Z' description: The date and time with seconds, the step execution has ended in UTC format. lastUpdated: type: string example: '2023-05-30T13:04:03.574Z' description: The date and time with seconds, the step has last updated in UTC format. statusMessage: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Displays status for a step.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" exitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Exit Code for a step.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" name: type: string example: moveusersvalidateAndMove description: Step name. timeElapsed: type: string example: PT2.752S description: Time lapsed in seconds since the job execution started. PersonPrimaryAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If the phone number is used as a location CLID. telephonyType: type: string enum: - PSTN_NUMBER - MOBILE_NUMBER description: "The telephony type for the number.\n * `PSTN_NUMBER` - The object is a PSTN number.\n * `MOBILE_NUMBER` - The object is a mobile number.\n" mobileNetwork: type: string example: mobileNetwork description: Mobile Network for the number if the number's `telephonyType` is `MOBILE_NUMBER`. routingProfile: type: string example: AttRtPf description: Routing Profile for the number if the number's `telephonyType` is `MOBILE_NUMBER`. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. PersonCallInterceptAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonCallInterceptAvailableNumberObject' description: Array of phone numbers. UserPlaceAuthorizationCodeListPatch: type: object properties: deleteCodes: type: array items: type: string description: Access Codes to delete. CallBridgeInfo: type: object required: - warningToneEnabled properties: warningToneEnabled: type: boolean description: Indicates that a stutter dial tone will be played to all the participants when a virtual line is bridged on the active shared line call. PersonFaxMessageAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonFaxMessageAvailableNumberObject' description: Array of phone numbers. MoveUsersStartJobResponse: type: object required: - response properties: response: $ref: '#/components/schemas/StartJobResponseObject' description: Contains the response for the user moves. PutAgentCallCallerId: type: object required: - selectedCallerId properties: selectedCallerId: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvZWZkN2JjYzAtMjNkNS00NWM2LTk1N2YtZWNhYWEyZDU0M2Uw description: The unique identifier of the call queue or hunt group to use for the agent's caller ID. Set to null to use the agent's own caller ID. ExecutiveAssistantSettingsPut: type: object description: Request Payload to update settings for an executive assistant. example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+19075552860' executives: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true properties: forwardFilteredCallsEnabled: type: boolean example: true description: If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`. forwardToPhoneNumber: type: string example: '+19075552860' description: Phone number to forward the filtered calls to. Mandatory if `forwardFilteredCallsEnabled` is set to true. executives: type: array items: $ref: '#/components/schemas/ExecutivePut' description: List of executives. 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. MoveUsersErrorResponse: type: object required: - error properties: error: type: array items: $ref: '#/components/schemas/ErrorOrImpactItem' description: Contains a list of error items. ExecutivePut: type: object description: Details of an executive for whom the assistant can manage calls. example: personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true required: - personId - optInEnabled properties: personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM description: Unique identifier of the executive. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. SelectiveAcceptCallCriteria: type: object required: - id - scheduleName - source - acceptEnabled 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 selective reject is in effect. source: $ref: '#/components/schemas/SelectiveAcceptCallSource' description: If criteria are applicable for calls from any phone number, specific phone number or forwarded ones. acceptEnabled: type: boolean example: true description: This setting specifies to choose to accept or not to accept the calls that fit within these parameters. ExecutiveCallFilteringCriteriaGet: type: object description: Executive call filtering criteria detailed settings response object that contains the schedule, phone numbers, and routing configuration. required: - id - filterName - callsFrom - filterEnabled properties: id: type: string description: Unique identifier for the filter criteria. filterName: type: string description: Name of the criteria. scheduleName: type: string description: Name of the schedule associated with this criteria. scheduleType: type: string enum: - holidays - businessHours 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" 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 (Location) level.\n" callsFrom: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS - ANY_INTERNAL - ANY_EXTERNAL description: " * `ANY_PHONE_NUMBER` - The criteria applies to any phone number.\n * `SELECT_PHONE_NUMBERS` - The criteria applies to selected phone numbers.\n * `ANY_INTERNAL` - The criteria applies to any internal number.\n * `ANY_EXTERNAL` - The criteria applies to any external number.\n" anonymousCallersEnabled: type: boolean description: Indicates if the criteria applies to anonymous callers. unavailableCallersEnabled: type: boolean description: Indicates if the criteria applies to unavailable callers. phoneNumbers: type: array description: The list of phone numbers that this filtering criteria applies to, when `callsFrom` is set to `SELECT_PHONE_NUMBERS`. items: type: string description: Phone number that the criteria applies to based on `callsFrom` selection. filterEnabled: type: boolean description: Controls the action when this criteria matches a call. When `true`, matching calls are filtered and will alert the executive's assistants. When `false`, matching calls are not filtered and will not alert the executive's assistants. Criteria with `filterEnabled` as `false` take precedence over other filtering criteria with `filterEnabled` as `true`, allowing exceptions where certain calls are not filtered to the executive's assistants. callsToNumbers: type: array description: List of numbers for the executive that will match the criteria when called. This may include the executive’s primary number and/or extension, as well as secondary (alternate) numbers (and associated extensions). If the list is empty, any number or extension for the executive matches the criteria when called. If the list is not empty, only the specified numbers and their extensions match the criteria. items: type: object description: Executive phone number that will match the criteria when called. properties: type: type: string enum: - PRIMARY - ALTERNATE description: " * `PRIMARY` - Number is assigned as primary to executive.\n * `ALTERNATE` - Number is assigned as alternate (secondary) to the executive.\n" phoneNumber: type: string description: The phone number assigned to the executive that will be used to match criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 filterName: VIP Callers scheduleName: Business Hours scheduleType: businessHours scheduleLevel: PEOPLE callsFrom: SELECT_PHONE_NUMBERS anonymousCallersEnabled: false unavailableCallersEnabled: false phoneNumbers: - '+14085551234' - '+14085551235' filterEnabled: true callsToNumbers: - type: PRIMARY phoneNumber: '+14085556789' CallsFromSelectiveAccept: type: string enum: - ANY_PHONE_NUMBER - SELECT_PHONE_NUMBERS description: " * `ANY_PHONE_NUMBER` - Criteria applies for any incoming number.\n * `SELECT_PHONE_NUMBERS` - Criteria applies for selected incoming numbers.\n" UserListItem: type: object required: - userId properties: userId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw description: User ID associated with the validation response. impacts: type: array items: $ref: '#/components/schemas/ErrorOrImpactItem' description: List of impacts for the user moves. errors: type: array items: $ref: '#/components/schemas/ErrorOrImpactItem' description: List of errors for the user moves. 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" ApplicationAvailableSharedLineMemberList: type: object properties: members: type: array items: $ref: '#/components/schemas/ApplicationAvailableSharedLineMemberItem' description: List of members available for shared-line assignment to a Webex Calling Apps. description: List of members available for shared-line assignment to a Webex Calling Apps. ModeManagementFeatureTypeObject: type: string enum: - AUTO_ATTENDANT - CALL_QUEUE - HUNT_GROUP description: " * `AUTO_ATTENDANT` - Specifies the feature is an Auto Attendant.\n * `CALL_QUEUE` - Specifies the feature is a Call Queue.\n * `HUNT_GROUP` - Specifies the feature is a Hunt Group.\n" StateGet: type: object required: - code - name properties: code: type: string example: CA description: Two-letter state or province abbreviation (e.g., CA for California). name: type: string example: California description: Full name of the state or province. JobDetailsResponseById: type: object required: - name - id - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - counts properties: name: type: string example: moveusers description: Job name. id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk description: Unique identifier of the job. trackingId: type: string example: ROUTER_ebb52b5b description: d060-4164-9757-48b383423d73` (string, required) - Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier to identify the customer for which the job was run. instanceId: type: number example: 11 description: Unique identifier to identify the instance of the job. jobExecutionStatus: type: array items: $ref: '#/components/schemas/JobExecutionStatusObject' description: Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job. latestExecutionStatus: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Most recent status of the job at the time of invocation.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" counts: $ref: '#/components/schemas/CountObject' description: Job statistics. csvFile: type: string example: 02124eef-7be6-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12 description: Reference ID for the file that holds the errors and impacts. csvFileExpiryTime: type: string example: '2023-07-12T12:20:33.503Z' description: Date and time with seconds, the file expires in UTC format. fileFormat: type: string example: text/csv description: Format of the file generated. csvFileDownloadUrl: type: string example: https://files-int-us-east-1.webexcontent.com/5ab33047-d7ad-42dd-83c5-2e73da63b2ad/8c54b800-10ed-11ee-97c3-a38ed64ceaf4?x-amz-meta-tracking-id=NA_33b1a151-4c47-46a5-8fc5-09f3111c4313&x-amz-meta-user-id=ef2e385f-acad-4e90-8c10-c6532aa0c28d&Expires=1687440028&Signature=ckIcTq-7mUfcdsvSbAR5cUGC76FfyJ6D06~bKXuCrfHkku-eqPsMImRIBCqvWoBRQ1nwGdZk043AFXrwKMxDR9y~GJkzPVAjZwEU3Rr1pK-2aVEDMzP8AVlMYQmJPrmVFlnX8AxDh9YnCeoGUhwUbT~wjyj~NJP3PGfc-hwyXWnFTmdvL3Ehn66z9BQxKksZMOWCyghd~9otoBVC-WyA1Nx2LDOT1qmlLeqN2xwWpdu5Atll0tPUQaOQbCP3-bnOcmL0tR~2gUzfBMUhsW7UO1IPD451va8qcw687~Mglu5VPdpWlIjVXZu6Qk1uCIWSQ0czRDOiFH6RKWtQCD95qw__&Key-Pair-Id=APKAJADAKLCI2FW2U32Q description: URL to the CSV file containing errors and impacts. ExecutiveAlertPut: type: object properties: alertingMode: type: string enum: - SEQUENTIAL - SIMULTANEOUS description: " * `SEQUENTIAL` - Alerts assistants one at a time in the defined order.\n * `SIMULTANEOUS` - Alerts all assistants at the same time.\n" nextAssistantNumberOfRings: type: integer description: Number of rings before alerting the next assistant when `alertingMode` is `SEQUENTIAL`. rolloverEnabled: type: boolean description: Controls whether the rollover timer (`rolloverWaitTimeInSecs`) is enabled. When set to `true`, rollover will trigger after the timer expires, even if assistants are still available. When `false`, rollover only occurs when no assistants remain. rolloverAction: type: string enum: - VOICE_MESSAGING - NO_ANSWER_PROCESSING - FORWARD description: "Specifies what happens when rollover is triggered.\n * `VOICE_MESSAGING` - The call is sent to the executive's voicemail.\n * `FORWARD` - The call is forwarded to the specified destination (`rolloverForwardToPhoneNumber`).\n * `NO_ANSWER_PROCESSING` - The call is sent to no answer processing which may trigger executive services such as call forwarding or voicemail.\nRollover is always triggered when no assistants remain for a filtered call. If the rollover timer is enabled, rollover can also be triggered when the timer expires, even if assistants are still available." rolloverForwardToPhoneNumber: type: string description: Phone number to forward calls to when rollover action is set to `FORWARD`. rolloverWaitTimeInSecs: type: integer description: Time in seconds to wait before applying the rollover action when `rolloverEnabled` is `true`. clidNameMode: type: string enum: - EXECUTIVE_ORIGINATOR - ORIGINATOR_EXECUTIVE - EXECUTIVE - ORIGINATOR - CUSTOM description: "Controls how Caller ID name is displayed on assistant's phone.\n * `EXECUTIVE_ORIGINATOR` - Display executive name followed by caller name.\n * `ORIGINATOR_EXECUTIVE` - Display caller name followed by executive name.\n * `EXECUTIVE` - Display only executive name.\n * `ORIGINATOR` - Display only caller name.\n * `CUSTOM` - Display a custom name.\n" customCLIDName: type: string description: Custom caller ID name to display when `clidNameMode` is set to `CUSTOM` (deprecated). customCLIDNameInUnicode: type: string description: Unicode Custom caller ID name to display when `clidNameMode` is set to `CUSTOM`. clidPhoneNumberMode: type: string enum: - EXECUTIVE - ORIGINATOR - CUSTOM description: "Controls which Caller ID phone number is displayed on assistant's phone.\n * `EXECUTIVE` - Display executive's phone number.\n * `ORIGINATOR` - Display caller's phone number.\n * `CUSTOM` - Display a custom phone number.\n" customCLIDPhoneNumber: type: string description: Custom caller ID phone number to display on assistant's phone when `clidPhoneNumberMode` is set to `CUSTOM`. AgentCallerId: type: object required: - selectedCallerId properties: selectedCallerId: $ref: '#/components/schemas/SelectedCallerIdObject' description: Indicates agent's Caller ID choice for outgoing calls. PersonPrimaryAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonPrimaryAvailableNumberObject' description: Array of phone numbers. JobDetailsResponse: type: object required: - id - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - counts properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk description: Unique identifier of the job. trackingId: type: string example: ROUTER_ebb52b5b-d060-4164-9757-48b383423d73 description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM description: Unique identifier to identify the customer for which the job was run. instanceId: type: number example: 10 description: Unique identifier to identify the instance of the job. jobExecutionStatus: type: array items: $ref: '#/components/schemas/JobExecutionStatusObject' description: Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job. latestExecutionStatus: type: string enum: - STARTING - STARTED - COMPLETED - FAILED - UNKNOWN - ABANDONED description: "Most recent status of the job at the time of invocation.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n" latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS - COMPLETED_WITH_PENDING_ORDERS description: "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n" counts: $ref: '#/components/schemas/CountObject' description: Job statistics. csvFile: type: string example: 02124eef-7be6-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12 description: Reference ID for the file that holds the errors and impacts. csvFileExpiryTime: type: string example: '2023-07-12T12:20:33.503Z' description: Date and time with seconds, the file expires in UTC format. fileFormat: type: string example: text/csv description: Format of the file generated. ExecutiveAssignedAssistantsPutRequestObject: type: object description: Request object for updating assigned assistants to the executive. example: assistantIds: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMzRmNjdhNS1kYTFiLTQxYzUtODBkNS03ZDFmZTY3ZTE5ZTY properties: assistantIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U description: Unique identifier of the assistant. description: List of people to be assigned as assistant. To remove all assigned assistants, set `assistantIds` to `null`. VoiceMessageDetails: type: object required: - id - callingParty - created properties: id: type: string example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvNmQ0MTgyMTItZjUwNi00Yzk4LTk5MTItNmI1MmE1ZmU2ODgx description: The message identifier of the voicemail message. duration: type: number example: 38 description: ' The duration (in seconds) of the voicemail message. Duration is not present for a FAX message.' callingParty: $ref: '#/components/schemas/VoiceMailPartyInformation' description: The calling party's details. For example, if user A calls user B and leaves a voicemail message, then A is the calling party. urgent: type: boolean description: '`true` if the voicemail message is urgent.' confidential: type: boolean description: '`true` if the voicemail message is confidential.' read: type: boolean example: true description: '`true` if the voicemail message has been read.' faxPageCount: type: number example: 2 description: Number of pages for the FAX. Only set for a FAX. created: type: string example: '2021-11-14T17:00:00.000Z' description: The date and time the voicemail message was created. AvailableCallerIdList: type: object required: - availableCallerIds properties: availableCallerIds: type: array items: $ref: '#/components/schemas/AvailableCallerIdObject' description: A list of call queues and hunt groups that the agent belongs to and are available to be selected as the Caller ID for outgoing calls. Call queues and hunt groups which have disabled using the phone number as Caller ID are not returned. UserPlaceAuthorizationCodeAdd: type: object required: - code - description properties: code: type: string example: '4856' description: An Access code. description: type: string example: Marketing's access code description: The description of the access code. ApplicationAvailableSharedLineMemberItem: type: object required: - id - firstName - lastName - lineType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE description: A unique member identifier. firstName: type: string example: John description: First name of member. lastName: type: string example: Doe description: Last name of member. phoneNumber: type: string example: '1234567890' description: Phone number of member. Currently, E.164 format is not supported. extension: type: string example: '0000' description: Phone extension of member. lineType: $ref: '#/components/schemas/LineType' description: Indicates if the line is acting as a primary line or a shared line for this device. location: $ref: '#/components/schemas/location' description: Location object having a unique identifier for the location and its name. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12348080' description: Routing prefix + extension of a person or workspace. description: Member available for shared-line assignment to a Webex Calling Apps. UserItem: type: object required: - userId properties: userId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw description: User ID to be moved. extension: type: string example: '28544' description: Extension to be moved. Extension is only supported for calling user. Only one new extension can be moved to the target location for a user. An empty value will remove the configured extension. If not provided, the existing extension will be retained. phoneNumber: type: string example: '+18632520486' description: Phone number to be moved. Phone number is only supported for calling user. Only one new phone number belonging to the target location can be assigned to a user. The phone number must follow the E.164 format. An empty value will remove the configured phone number. If not provided, the existing phone number will be moved to the target location. UserNumbersPatch: type: object required: - phoneNumbers properties: distinctiveRingEnabled: type: boolean example: true description: Enables a distinctive ring pattern for the person. phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumber' description: List of phone numbers that are assigned to a person. SelectedCallerIdObject: type: object required: - id - type - name - phoneNumber - extension properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMjE3ZDU3YmEtOTMxYi00ZjczLTk1Y2EtOGY3MWFhYzc4MTE5 description: When not null, this is the call queue or hunt group's unique identifier. type: $ref: '#/components/schemas/AgentCallerIdType' description: When not null, indicates whether a call queue or hunt group has been selected. name: type: string example: SalesQueue description: When not null, indicates the call queue's or hunt group's name. phoneNumber: type: string example: '4255558100' description: When not null, indicates the call queue's or hunt group's phone number. extension: type: string example: '8100' description: When not null, indicates the call queue's or hunt group's extension number. ExecutiveCallFilteringPatch: type: object description: Executive call filtering settings request object for updating the filter configuration and criteria activation. properties: enabled: type: boolean description: Set to `true` to enable executive call filtering or `false` to disable it. filterType: type: string enum: - CUSTOM_CALL_FILTERS - ALL_CALLS - ALL_INTERNAL_CALLS - ALL_EXTERNAL_CALLS description: " * `CUSTOM_CALL_FILTERS` - Choose this option to ensure that only specific calls are sent to the executive assistant.\n * `ALL_CALLS` - Choose this option to send both internal and external calls to the executive assistant.\n * `ALL_INTERNAL_CALLS` - Choose this option to send all internal calls to the executive assistant.\n * `ALL_EXTERNAL_CALLS` - Choose this option to send all external calls to the executive assistant.\n" criteriaActivation: type: array description: The list of criteria activation settings to update for executive call filtering. items: type: object required: - id - activationEnabled description: The activation configuration for an individual filter criterion. properties: id: type: string description: Unique identifier for the filter criteria. activationEnabled: type: boolean description: Controls whether this filter criteria is active. When `true`, the criteria is evaluated for incoming calls. When `false`, the criteria is completely ignored and has no effect on call filtering. UserOutgoingPermissionDigitPatternPostObject: type: object required: - name - pattern - action - transferEnabled properties: name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. UpdateUserCallCaptionsObject: type: object properties: userClosedCaptionsEnabled: type: boolean example: true description: Enable or disable user-level closed captions. userTranscriptsEnabled: type: boolean example: true description: Enable or disable user-level transcripts. useLocationSettingsEnabled: type: boolean example: true description: If `useLocationSettingsEnabled` is `true`, location settings will control the user's closed captions and transcripts. Otherwise, user-level settings are used. ExecutiveAvailableAssistantsGet: type: object example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' properties: assistants: type: array items: $ref: '#/components/schemas/AvailableAssistant' description: List of people available for assignment as executive assistants. PersonalAssistantGet: type: object required: - enabled - presence - transferEnabled - alerting - alertMeFirstNumberOfRings properties: enabled: type: boolean example: true description: Toggles feature. presence: type: string enum: - NONE - BUSINESS_TRIP - GONE_FOR_THE_DAY - LUNCH - MEETING - OUT_OF_OFFICE - TEMPORARILY_OUT - TRAINING - UNAVAILABLE - VACATION description: "Person's availability.\n * `NONE` - User is available.\n * `BUSINESS_TRIP` - User is gone for a business trip.\n * `GONE_FOR_THE_DAY` - User is gone for the day.\n * `LUNCH` - User is gone for lunch.\n * `MEETING` - User is gone for a meeting.\n * `OUT_OF_OFFICE` - User is out of office.\n * `TEMPORARILY_OUT` - User is temporarily out.\n * `TRAINING` - User is gone for training.\n * `UNAVAILABLE` - User is unavailable.\n * `VACATION` - User is gone for vacation.\n" untilDateTime: type: string example: '2022-08-24T06:18:31.092Z' description: The date until which personal assistant is active. transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. transferNumber: type: string example: '+14126525012' description: Number to transfer to. alerting: type: string enum: - ALERT_ME_FIRST - PLAY_RING_REMINDER - NONE description: "Alert type.\n * `ALERT_ME_FIRST` - Ring the recipient first.\n * `PLAY_RING_REMINDER` - Reminder ring the recipient.\n * `NONE` - No alert.\n" alertMeFirstNumberOfRings: type: number example: 3 description: 'Number of rings for alert type: `ALERT_ME_FIRST`; available range is 2-20' PhoneNumber: type: object required: - primary - action - directNumber properties: primary: type: boolean example: true description: If `true` marks the phone number as primary. action: $ref: '#/components/schemas/Action' description: Either 'ADD' to add phone numbers or 'DELETE' to remove phone numbers. directNumber: type: string example: '+12145553567' description: Phone numbers that are assigned. extension: type: string example: '1234' description: Extension that is assigned. ringPattern: $ref: '#/components/schemas/RingPattern' description: Ring Pattern of this number. SelectiveForwardCallCriteria: type: object required: - id - scheduleName - 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 sequential ring is in effect. source: $ref: '#/components/schemas/SourceForSelectiveForward' description: Criteria are applicable for calls from any phone number or a specific phone number. 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. Executive: type: object description: Details of an executive for whom the assistant can manage calls. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: +91-6557765419 extension: '10079' optInEnabled: true required: - id - directNumber - extension - optInEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM description: Unique identifier of the executive. firstName: type: string example: John description: Unicode first name of the executive. Is null if not available or if the name is a single ‘.’ or ‘-’. lastName: type: string example: Doe description: Unicode last name of the executive. Is null if not available or if the name is a single ‘.’ or ‘-’. directNumber: type: string example: '+916557765419' description: Direct number of the executive. extension: type: string example: '10079' description: Extension number of the executive. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. AudioAnnouncementFileObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all four fields are provided, file with given `id` is used and other fields are ignored. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" PersonCallForwardAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonCallForwardAvailableNumberObject' description: Array of phone numbers. ItemObject: type: object properties: item: type: string description: Phone number itemNumber: type: number description: Index of error number. trackingId: type: string description: Unique identifier to track the HTTP requests. error: $ref: '#/components/schemas/ErrorObject' ApplicationPutSharedLineMemberItem: type: object required: - id - port - primaryOwner - lineType - lineWeight properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE description: Unique identifier for the person or workspace. port: type: number example: 1 description: Device port number assigned to person or workspace. primaryOwner: type: string example: 'true' description: If `true` the person or the workspace is the owner of the device. Points to primary line/port of the device. lineType: $ref: '#/components/schemas/LineType' description: Indicates if the line is acting as a primary line or a shared line for this device. lineWeight: type: number minimum: 1 example: 1 description: Number of lines that have been configured for the person on the device. allowCallDeclineEnabled: type: boolean example: true description: Set how a device behaves when a call is declined. When set to `true`, a call decline request is extended to all the endpoints on the device. When set to `false`, a call decline request is only declined at the current endpoint. lineLabel: type: string example: share line label description: Device line label. description: Member to be added or modified for shared-line assignment to a Webex Calling Apps. TransferNumberPatch: type: object required: - useCustomTransferNumbers properties: useCustomTransferNumbers: type: boolean example: true description: When `true`, use custom settings for the transfer numbers category of outbound permissions. autoTransferNumber1: type: string example: '"+1201203650"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber2: type: string example: '"+1201203651"' description: When calling a specific call type, this workspace will be automatically transferred to another number. autoTransferNumber3: type: string example: '"+1201203652"' description: When calling a specific call type, this workspace will be automatically transferred to another number. AvailableCallerIdObject: type: object required: - id - type - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMjE3ZDU3YmEtOTMxYi00ZjczLTk1Y2EtOGY3MWFhYzc4MTE5 description: Call queue or hunt group's unique identifier. type: $ref: '#/components/schemas/AgentCallerIdType' description: Member is of type `CALL_QUEUE` or `HUNT_GROUP`. name: type: string example: TestCallQueue description: Call queue or hunt group's name. phoneNumber: type: string example: '+441234200090' description: When not null, it is call queue or hunt group's phone number. extension: type: string example: '6001' description: When not null, it is call queue or hunt group's extension number. SelectiveForwardCallSettingPatch: type: object properties: enabled: type: boolean example: true description: '`true` if the Selective Forward feature is enabled.' defaultPhoneNumberToForward: type: string example: '+1934898988' description: Enter the phone number to forward calls to during this schedule. ringReminderEnabled: type: boolean example: true description: When `true`, enables a ring reminder for such calls. destinationVoicemailEnabled: type: boolean description: Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions. ErrorMessageObject: type: object properties: description: type: string description: Error message. code: type: string description: Internal error code. locationId: type: string description: Error messages describing the location ID in which the error occurs. For a move operation, this is the target location ID. ExecutiveAlertGet: type: object required: - alertingMode - rolloverWaitTimeInSecs - clidNameMode - clidPhoneNumberMode properties: alertingMode: type: string enum: - SEQUENTIAL - SIMULTANEOUS description: " * `SEQUENTIAL` - Alerts assistants one at a time in the defined order.\n * `SIMULTANEOUS` - Alerts all assistants at the same time.\n" nextAssistantNumberOfRings: type: integer description: Number of rings before alerting the next assistant when `alertingMode` is `SEQUENTIAL`. rolloverEnabled: type: boolean description: Controls whether the rollover timer (`rolloverWaitTimeInSecs`) is enabled. When set to `true`, rollover will trigger after the timer expires, even if assistants are still available. When `false`, rollover only occurs when no assistants remain. rolloverAction: type: string enum: - VOICE_MESSAGING - NO_ANSWER_PROCESSING - FORWARD description: "Specifies what happens when rollover is triggered.\n * `VOICE_MESSAGING` - The call is sent to the executive's voicemail.\n * `FORWARD` - The call is forwarded to the specified destination (`rolloverForwardToPhoneNumber`).\n * `NO_ANSWER_PROCESSING` - The call is sent to no answer processing which may trigger executive services such as call forwarding or voicemail.\nRollover is always triggered when no assistants remain for a filtered call. If the rollover timer is enabled, rollover can also be triggered when the timer expires, even if assistants are still available." rolloverForwardToPhoneNumber: type: string description: Phone number to forward calls to when rollover action is set to `FORWARD`. rolloverWaitTimeInSecs: type: integer description: Time in seconds to wait before applying the rollover action when `rolloverEnabled` is `true`. clidNameMode: type: string enum: - EXECUTIVE_ORIGINATOR - ORIGINATOR_EXECUTIVE - EXECUTIVE - ORIGINATOR - CUSTOM description: "Controls how Caller ID name is displayed on assistant's phone.\n * `EXECUTIVE_ORIGINATOR` - Display executive name followed by caller name.\n * `ORIGINATOR_EXECUTIVE` - Display caller name followed by executive name.\n * `EXECUTIVE` - Display only executive name.\n * `ORIGINATOR` - Display only caller name.\n * `CUSTOM` - Display a custom name.\n" customCLIDName: type: string description: Custom caller ID name to display when `clidNameMode` is set to `CUSTOM` (deprecated). customCLIDNameInUnicode: type: string description: Unicode Custom caller ID name to display when `clidNameMode` is set to `CUSTOM`. clidPhoneNumberMode: type: string enum: - EXECUTIVE - ORIGINATOR - CUSTOM description: "Controls which Caller ID phone number is displayed on assistant's phone.\n * `EXECUTIVE` - Display executive's phone number.\n * `ORIGINATOR` - Display caller's phone number.\n * `CUSTOM` - Display a custom phone number.\n" customCLIDPhoneNumber: type: string description: Custom caller ID phone number to display on assistant's phone when `clidPhoneNumberMode` is set to `CUSTOM`. example: alertingMode: SEQUENTIAL nextAssistantNumberOfRings: 3 rolloverEnabled: true rolloverAction: VOICE_MESSAGING rolloverForwardToPhoneNumber: '+14085267209' rolloverWaitTimeInSecs: 60 clidNameMode: EXECUTIVE_ORIGINATOR customCLIDName: John Anderson customCLIDNameInUnicode: '' clidPhoneNumberMode: EXECUTIVE customCLIDPhoneNumber: '+14085267208' endpointInformation: type: object required: - preferredAnswerEndpointId - endpoints properties: preferredAnswerEndpointId: type: string example: Y2lzY29z... description: Person’s preferred answer endpoint. nullable: true endpoints: type: array items: $ref: '#/components/schemas/endpoints' description: Array of endpoints available to the person. SettingsObject: type: object required: - settingName - level - value - lastModified properties: settingName: type: string enum: - HIDE_WEBEX_APP - PRESENCE_SYNC description: "Name of the setting retrieved.\n * `HIDE_WEBEX_APP` - Webex will continue to run but its windows will be closed by default. Users can still access Webex from the system tray on Windows or the Menu Bar on Mac.\n * `PRESENCE_SYNC` - Sync presence status between Microsoft Teams and Webex.\n" level: type: string enum: - GLOBAL - ORGANIZATION - GROUP - PEOPLE description: "Level at which the `settingName` has been set.\n * `GLOBAL` - `settingName` configured at the `GLOBAL` `level`.\n * `ORGANIZATION` - `settingName` configured at the `ORGANIZATION` `level`.\n * `GROUP` - `settingName` configured at the `GROUP` `level`.\n * `PEOPLE` - `settingName` configured at the `PEOPLE` `level`.\n" value: type: boolean example: true description: Either `true` or `false` for the respective `settingName` to be retrieved. lastModified: type: string example: '2024-02-24T07:21:23.494198Z' description: The date and time when the respective `settingName` was last updated. PersonECBNAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/PersonECBNAvailableNumberObject' description: Array of phone numbers. SelectiveForwardCallCriteriaGet: type: object required: - forwardToPhoneNumber - sendToVoicemailEnabled - callsFrom properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI description: Criteria ID. forwardToPhoneNumber: type: string example: '+18898988831' description: Number to which calls needs to be forwarded. sendToVoicemailEnabled: type: boolean description: Boolean flag to enable/disable sending calls to voicemail. 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 type of schedule. scheduleLevel: $ref: '#/components/schemas/ScheduleLevel' description: Schedule level of the criteria. callsFrom: $ref: '#/components/schemas/CallsFromSelectiveReject' description: Reject calls selection. anonymousCallersEnabled: type: boolean example: true description: Calls From custom numbers, private number enabled. unavailableCallersEnabled: type: boolean example: true description: Calls From custom numbers, unavailable number 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. forwardEnabled: type: boolean example: true description: Boolean flag to enable/disable selective call forward. LineType: type: string enum: - PRIMARY - SHARED_CALL_APPEARANCE description: " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n" 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" JobListResponse: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/JobDetailsResponse' description: Lists all jobs for the customer in order of most recent one to oldest one irrespective of its status. UserDigitPatternObject: type: object required: - id - name - pattern - action - transferEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 description: A unique identifier for the digit pattern. name: type: string example: DigitPattern1 description: A unique name for the digit pattern. pattern: type: string example: 1XXX description: The digit pattern to be matched with the input number. action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. ExceptionTypeObject: type: string enum: - MANUAL_SWITCH_BACK - AUTOMATIC_SWITCH_BACK_EARLY_START - AUTOMATIC_SWITCH_BACK_EXTENSION - AUTOMATIC_SWITCH_BACK_STANDARD description: " * `MANUAL_SWITCH_BACK` - The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manually switches the feature back to normal operation or a different mode.\n * `AUTOMATIC_SWITCH_BACK_EARLY_START` - The mode was switched to by the user before its start time and runs as an exception until its end time is reached, at which point it automatically switches the feature back to normal operation.\n * `AUTOMATIC_SWITCH_BACK_EXTENSION` - The current mode was extended by the user before its end time and runs as an exception until the extension end time (mode's end time + extension of up to 12 hours) is reached, at which point it automatically switches the feature back to normal operation.\n * `AUTOMATIC_SWITCH_BACK_STANDARD` - The mode will remain the current operating mode for the feature until its normal end time is reached.\n" GetSharedLineMemberItem: type: object required: - id - firstName - lastName - port - primaryOwner - lineType - lineWeight - hotlineEnabled - hotlineDestination - allowCallDeclineEnabled - memberType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85ODhiYTQyOC0zMjMyLTRmNjItYjUyNS1iZDUzZmI4Nzc0MWE description: Unique identifier for the member. firstName: type: string example: John description: First name of person or workspace. lastName: type: string example: Doe description: Last name of person or workspace. phoneNumber: type: string example: '2056852221' description: Phone number of a person or workspace. Currently, E.164 format is not supported. This will be supported in the future update. extension: type: string example: '1111' description: Phone extension of a person or workspace. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341111' description: Routing prefix + extension of a person or workspace. port: type: number minimum: 1 example: 1 description: Device port number assigned to a person or workspace. t38FaxCompressionEnabled `true`: type: boolean description: T.38 Fax Compression setting. Valid only for ATA Devices. Overrides user level compression options. primaryOwner: type: string example: 'true' description: If `true` the person or the workspace is the owner of the device. Points to primary line/port of the device. lineType: $ref: '#/components/schemas/LineType' description: If the line is acting as a primary line or a shared line for this device. lineWeight: type: number minimum: 1 example: 1 description: Number of lines that have been configured for the person on the device. hostIP: type: string example: 198.168.0.1 description: Registration home IP for the line port. remoteIP: type: string example: 198.168.0.2 description: Registration remote IP for the line port. hotlineEnabled: type: boolean example: true description: Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination. hotlineDestination: type: string example: '1234' description: Preconfigured number for the hotline. Required only if `hotlineEnabled` is set to `true`. allowCallDeclineEnabled: type: boolean example: true description: Set how a device behaves when a call is declined. When set to `true`, a call decline request is extended to all the endpoints on the device. When set to `false`, a call decline request is only declined at the current endpoint. lineLabel: type: string example: share line label description: Device line label. memberType: $ref: '#/components/schemas/UserType' description: If the member is of type `PEOPLE` or `PLACE`. location: $ref: '#/components/schemas/location' description: Location object having a unique identifier for the location and its name. 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 SelectiveRejectCriteria: 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 location's schedule which determines when the selective reject is in effect. source: $ref: '#/components/schemas/SelectiveRejectCallSource' description: If criteria are applicable for calls from any phone number, specific phone number or forwarded ones. rejectEnabled: type: boolean example: true description: This setting specifies to choose to reject or not to reject the calls that fit within these parameters. CountryConfigGet: type: object required: - stateRequired - zipCodeRequired - states - timeZones example: stateRequired: true zipCodeRequired: true states: - code: CA name: California timeZones: - America/Los_Angeles properties: stateRequired: type: boolean example: true description: Indicates whether state is required for this country. zipCodeRequired: type: boolean example: true description: Indicates whether zip code is required for this country. states: type: array items: $ref: '#/components/schemas/StateGet' description: List of states available for this country. Returns all items in a single response. timeZones: type: array items: type: string example: America/Los_Angeles description: List of time zones supported for this country. Returns all items in a single response. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN number. ' 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