Webex User Call Settings (2/2) API

APIs for managing user call settings including music on hold, access codes, transfer numbers, digit patterns, and more.

Operations 94

GET /people/{personId}/features/applications Retrieve a person's Application Services Settings New #
POST /telephony/config/jobs/person/moveLocation Validate or Initiate Move Users Job #
GET /telephony/config/jobs/person/moveLocation List Move Users Jobs #
GET /telephony/config/jobs/person/moveLocation/{jobId} Get Move Users Job Status #
POST /telephony/config/jobs/person/moveLocation/{jobId}/actions/pause/invoke Pause the Move Users Job #
POST /telephony/config/jobs/person/moveLocation/{jobId}/actions/resume/invoke Resume the Move Users Job #
GET /telephony/config/jobs/person/moveLocation/{jobId}/errors List Move Users Job errors #
GET /telephony/config/people/{personId}/musicOnHold Retrieve Music On Hold Settings for a Person #
PUT /telephony/config/people/{personId}/musicOnHold Configure Music On Hold Settings for a Person #
GET /telephony/config/people/{personId}/outgoingPermission/accessCodes Retrieve Access Codes for a Person #
PUT /telephony/config/people/{personId}/outgoingPermission/accessCodes Modify Access Codes for a Person #
POST /telephony/config/people/{personId}/outgoingPermission/accessCodes Create Access Codes for a Person #
DELETE /telephony/config/people/{personId}/outgoingPermission/accessCodes Delete Access Codes for a Person #
GET /telephony/config/people/{personId}/outgoingPermission/autoTransferNumbers Retrieve Transfer Numbers for a Person #
PUT /telephony/config/people/{personId}/outgoingPermission/autoTransferNumbers Modify Transfer Numbers for a Person #
GET /telephony/config/people/{personId}/outgoingPermission/digitPatterns Retrieve Digit Patterns for a Person #
POST /telephony/config/people/{personId}/outgoingPermission/digitPatterns Create Digit Patterns for a Person #
PUT /telephony/config/people/{personId}/outgoingPermission/digitPatterns Modify the Digit Pattern Category Control Settings for a Person #
DELETE /telephony/config/people/{personId}/outgoingPermission/digitPatterns Delete all Digit Patterns for a Person #
GET /telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId} Retrieve Digit Pattern Details for a Person #
PUT /telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId} Modify a Digit Pattern for a Person #
DELETE /telephony/config/people/{personId}/outgoingPermission/digitPatterns/{digitPatternId} Delete a Digit Pattern for a Person #
PUT /telephony/config/people/{personId}/numbers Assign or Unassign numbers to a person #
GET /telephony/config/people/{personId}/preferredAnswerEndpoint Get Preferred Answer Endpoint #
PUT /telephony/config/people/{personId}/preferredAnswerEndpoint Modify Preferred Answer Endpoint #
GET /telephony/config/people/{personId}/applications/{applicationId}/availableMembers Search Shared-Line Appearance Members #
GET /telephony/config/people/{personId}/applications/{applicationId}/members Get Shared-Line Appearance Members #
PUT /telephony/config/people/{personId}/applications/{applicationId}/members Put Shared-Line Appearance Members #
PUT /telephony/config/people/{personId}/voicemail/passcode Modify a person's voicemail passcode #
GET /telephony/voiceMessages/summary Get Message Summary #
GET /telephony/voiceMessages List Messages #
DELETE /telephony/voiceMessages/{messageId} Delete Message #
POST /telephony/voiceMessages/markAsRead Mark As Read #
POST /telephony/voiceMessages/markAsUnread Mark As Unread #
GET /telephony/config/people/{personId}/agent/availableCallerIds Retrieve Agent's List of Available Caller IDs #
GET /telephony/config/people/{personId}/agent/callerId Retrieve Agent's Caller ID Information #
PUT /telephony/config/people/{personId}/agent/callerId Modify Agent's Caller ID Information #
GET /telephony/config/people/{personId}/features/callBridge Read Call Bridge Settings for a Person #
PUT /telephony/config/people/{personId}/features/callBridge Configure Call Bridge Settings for a Person #
GET /telephony/config/people/{personId}/secondary/availableNumbers Get Person Secondary Available Phone Numbers #
GET /telephony/config/people/{personId}/faxMessage/availableNumbers Get Person Fax Message Available Phone Numbers #
GET /telephony/config/people/{personId}/callForwarding/availableNumbers Get Person Call Forward Available Phone Numbers #
GET /telephony/config/people/primary/availableNumbers Get Person Primary Available Phone Numbers #
GET /telephony/config/people/{personId}/emergencyCallbackNumber/availableNumbers Get Person ECBN Available Phone Numbers #
GET /telephony/config/people/{personId}/callIntercept/availableNumbers Get Person Call Intercept Available Phone Numbers #
GET /telephony/config/people/{personId}/settings/msTeams Retrieve a Person's MS Teams Settings #
PUT /telephony/config/people/{personId}/settings/msTeams Configure a Person's MS Teams Setting #
GET /telephony/config/people/{personId}/features/personalAssistant Get Personal Assistant #
PUT /telephony/config/people/{personId}/features/personalAssistant Update Personal Assistant #
GET /telephony/config/people/{personId}/modeManagement/availableFeatures Retrieve the List of Available Features #
GET /telephony/config/people/{personId}/modeManagement/features Retrieve the List of Features Assigned to a User for Mode Management #
PUT /telephony/config/people/{personId}/modeManagement/features Assign a List of Features to a User for Mode Management #
GET /telephony/config/people/{personId}/selectiveAccept Get the User’s Selective Call Accept Criteria List #
PUT /telephony/config/people/{personId}/selectiveAccept Update User’s Selective Call Accept Criteria #
POST /telephony/config/people/{personId}/selectiveAccept/criteria Create a Criteria to the User’s Selective Call Accept Service #
GET /telephony/config/people/{personId}/selectiveAccept/criteria/{id} Get a Criteria for the User’s Selective Call Accept Service #
PUT /telephony/config/people/{personId}/selectiveAccept/criteria/{id} Modify a Criteria From the User’s Selective Call Accept Service #
DELETE /telephony/config/people/{personId}/selectiveAccept/criteria/{id} Delete a Criteria From the User’s Selective Call Accept service #
GET /telephony/config/people/{personId}/selectiveReject Get the User’s Selective Call Rejection Criteria Listing #
PUT /telephony/config/people/{personId}/selectiveReject Update User’s Selective Call Rejection Criteria List #
POST /telephony/config/people/{personId}/selectiveReject/criteria Create a Criteria to the User’s Selective Call Rejection Service #
GET /telephony/config/people/{personId}/selectiveReject/criteria/{id} Get a Criteria for the User’s Selective Call Rejection Service #
PUT /telephony/config/people/{personId}/selectiveReject/criteria/{id} Modify a Criteria for the User’s Selective Call Rejection Service #
DELETE /telephony/config/people/{personId}/selectiveReject/criteria/{id} Delete a Criteria From the User’s Selective Call Rejection Service #
GET /telephony/config/people/{personId}/selectiveForward Get the User’s Selective Call Forwarding #
PUT /telephony/config/people/{personId}/selectiveForward Update User’s Selective Call Forwarding Criteria List #
POST /telephony/config/people/{personId}/selectiveForward/criteria Create a Criteria to the User’s Selective Call Forwarding Service #
GET /telephony/config/people/{personId}/selectiveForward/criteria/{id} Get a Criteria for the User’s Selective Call Forwarding Service #
PUT /telephony/config/people/{personId}/selectiveForward/criteria/{id} Modify a Criteria for the User’s Selective Call Forwarding Service #
DELETE /telephony/config/people/{personId}/selectiveForward/criteria/{id} Delete a Criteria From the User’s Selective Call Forwarding Service #
GET /telephony/config/people/{personId}/applications/availableMembers Search Shared-Line Appearance Members New #
GET /telephony/config/people/{personId}/applications/availableMembers/count Get Count of Shared-Line Appearance Members #
GET /telephony/config/people/{personId}/applications/members Get Shared-Line Appearance Members New #
PUT /telephony/config/people/{personId}/applications/members Put Shared-Line Appearance Members New #
GET /telephony/config/people/{personId}/callCaptions Get the user call captions settings #
PUT /telephony/config/people/{personId}/callCaptions Update the user call captions settings #
GET /telephony/config/people/{personId}/executive/callFiltering Get Person Executive Call Filtering Settings #
PUT /telephony/config/people/{personId}/executive/callFiltering Modify Person Executive Call Filtering Settings #
GET /telephony/config/people/{personId}/executive/callFiltering/criteria/{id} Get Person Executive Call Filtering Criteria Settings #
PUT /telephony/config/people/{personId}/executive/callFiltering/criteria/{id} Modify Person Executive Call Filtering Criteria Settings #
DELETE /telephony/config/people/{personId}/executive/callFiltering/criteria/{id} Delete Person Executive Call Filtering Criteria #
POST /telephony/config/people/{personId}/executive/callFiltering/criteria Add Person Executive Call Filtering Criteria #
GET /telephony/config/people/{personId}/executive/alert Get Person Executive Alert Settings #
PUT /telephony/config/people/{personId}/executive/alert Modify Person Executive Alert Settings #
GET /telephony/config/people/{personId}/executive/assignedAssistants Get Person Executive Assigned Assistants #
PUT /telephony/config/people/{personId}/executive/assignedAssistants Modify Person Executive Assigned Assistants #
GET /telephony/config/people/{personId}/executive/availableAssistants Get Person Executive Available Assistants #
GET /telephony/config/people/{personId}/executive/assistant Get Person Executive Assistant Settings #
PUT /telephony/config/people/{personId}/executive/assistant Modify Person Executive Assistant Settings #
GET /telephony/config/people/{personId}/executive/screening Get Person Executive Screening Settings #
PUT /telephony/config/people/{personId}/executive/screening Modify Person Executive Screening Settings #
GET /telephony/config/people/{personId} Get Timezone and Announcement Language Settings of a Person #
PUT /telephony/config/people/{personId} Update Timezone and Announcement Language Settings of a Person #
GET /telephony/config/countries/{countryCode} Get Country Calling Configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/webex-user-call-settings-2-2-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

webex-user-call-settings-2-2-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Webex User Call Settings (2/2) User Call Settings (2/2) API
  version: 1.0.0
  description: 'Operations tagged User Call Settings (2/2) across 2 of this provider''s published API definitions: webex-cloud-calling-openapi.json, webex-user-call-settings-2-2-api-openapi.yml. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of webex-cloud-calling-openapi.json, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours.
    derived_from: webex-cloud-calling-openapi.json
    operation_coverage: 94/94
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-cloud-calling.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-cloud-calling.json
tags:
- name: 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.


        <br/>


        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.


        <br/>


        Errors occurring during the initial API request validation are captured directly in the error response, along with the appropriate HTTP status code.


        <br/>


        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


        <br/>


        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.


        <br/>


        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}`


        <br/>


        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: 'Precon

# --- truncated at 32 KB (589 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-user-call-settings-2-2-api-openapi.yml