openapi: 3.0.0 info: title: Webex Admin Address Book Device Call Settings 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: Device Call Settings paths: /telephony/config/devices/{deviceId}/members: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetMemberResponse' example: model: DMS Cisco 192 members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: John lastName: Smith phoneNumber: '2055552221' extension: '000' routingPrefix: '1234' esn: '1234000' primaryOwner: true port: 1 t38FaxCompressionEnabled: false lineType: SHARED_CALL_APPEARANCE lineWeight: 1 hostIP: 10.0.0.45 remoteIP: 192.102.12.84 hotlineEnabled: true hotlineDestination: '+12055552222' allowCallDeclineEnabled: true lineLabel: share line label linePort: evypzco5ds@55552222.int10.bcld.webex.com memberType: PEOPLE location: name: MainOffice id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw maxLineCount: 2 '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 Device Members operationId: getDeviceMembers description: 'Get the list of all the members of the device including primary and secondary users. A device member can be either a person or a workspace. An admin can access the list of member details, modify member details and search for available members on a device. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Retrieves the list of all members of the device in this 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 Members on the device operationId: updateMembersOnDevice description: 'Modify member details on the device. A device member can be either a person, virtual line or a workspace. An admin can access the list of member details, modify member details and search for available members on a device. Modifying members on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Modify members on the device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: members: - port: 1 id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk t38FaxCompressionEnabled: false primaryOwner: true lineType: SHARED_CALL_APPEARANCE lineWeight: 1 allowCallDeclineEnabled: true hotlineDestination: '' hotlineEnabled: false lineLabel: share line label schema: $ref: '#/components/schemas/PutMembersRequest' /telephony/config/devices/{deviceId}/availableMembers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SearchMemberResponse' example: members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: John lastName: Smith phoneNumber: '+12055552221' t38FaxCompressionEnabled: false lineType: SHARED_CALL_APPEARANCE allowCallDeclineEnabled: true memberType: PEOPLE location: name: MainOffice id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: Bob lastName: Smith-ws phoneNumber: '+12055552221' t38FaxCompressionEnabled: false lineType: SHARED_CALL_APPEARANCE allowCallDeclineEnabled: true memberType: PLACE location: name: MainOffice id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw '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 Members operationId: searchMembers description: 'Search members that can be assigned to the device. A device member can be either a person or a workspace. A admin can access the list of member details, modify member details and search for available members on a device. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Retrieves the list of available members on the device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Specifies the offset from the first result that you want to fetch. example: 0 schema: type: number - name: max in: query description: Specifies the maximum number of records that you want to fetch. example: 100 schema: type: number default: 2000 - name: memberName in: query description: Search (Contains) numbers based on member name. example: John schema: type: string - name: phoneNumber in: query description: Search (Contains) based on number. example: '9828282867' schema: type: string - name: locationId in: query description: Unique identifier for the location. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: extension in: query description: Search (Contains) based on extension. example: '1234' schema: type: string - name: usageType in: query description: Search for members eligible to become the owner of the device, or share line on the device. example: SHARED_LINE schema: type: string enum: - DEVICE_OWNER - SHARED_LINE - name: order in: query description: 'Sort the list of available members on the device in ascending order by name, use either last name `lname` or first name `fname`. Default: last name in ascending order.' example: lname schema: type: string /telephony/config/devices/{deviceId}/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 members that can be assigned to the device. 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 Members operationId: getCountOfMembers description: 'Get the count of members that can be assigned to the device. A device member can be either a person or a workspace. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Retrieves the count of available members on the device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: memberName in: query description: Search (Contains) numbers based on member name. example: John schema: type: string - name: phoneNumber in: query description: Search (Contains) based on number. example: '9828282867' schema: type: string - name: locationId in: query description: Unique identifier for the location. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw schema: type: string - name: extension in: query description: Search (Contains) based on extension. example: '1234' schema: type: string - name: usageType in: query description: "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device." example: SHARED_LINE schema: type: string enum: - DEVICE_OWNER - SHARED_LINE /telephony/config/devices/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 members that can be assigned to devices. 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 Available Members operationId: getCountOfAvailableMembers description: 'Get the count of members that can be assigned to devices. A device member can be either a person or a workspace. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Retrieves the count of available members in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: memberName in: query description: Search (Contains) numbers based on member name. example: John schema: type: string - name: phoneNumber in: query description: Search (Contains) based on number. example: '9828282867' schema: type: string - name: locationId in: query description: Unique identifier for the location. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw schema: type: string - name: extension in: query description: Search (Contains) based on extension. example: '1234' schema: type: string - name: usageType in: query description: "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device." example: SHARED_LINE schema: type: string enum: - DEVICE_OWNER - SHARED_LINE - name: excludeVirtualLine in: query description: If true, filters out virtual lines from the available members list. example: true schema: type: boolean - name: deviceLocationId in: query description: Unique identifier for the device's location. When specified, filters available members to those in the same location as the device. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw schema: type: string /telephony/config/devices/{deviceId}/actions/applyChanges/invoke: 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: Apply Changes for a specific device operationId: applyChangesForASpecificDevice description: 'Issues request to the device to download and apply changes to the configuration. Applying changes for a specific device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Apply changes for a device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/{deviceId}/settings: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DeviceSettingsObjectForDeviceLevel' example: customizations: ata: audioCodecPriority: selection: REGIONAL primary: G711a secondary: G711u tertiary: G729a ataDtmfMode: STRICT ataDtmfMethod: AVT cdpEnabled: true lldpEnabled: true qosEnabled: true vlan: enabled: true value: 1 webAccessEnabled: true nightlyResyncEnabled: true snmp: enabled: false trustedIP: 0.0.0.0/0.0.0.0 getCommunity: public setCommunity: private snmpV3Enabled: false mpp: pnacEnabled: true audioCodecPriority: selection: CUSTOM primary: OPUS secondary: G722 tertiary: G711u backlightTimer: ONE_MIN background: customUrl: '' image: WEBEX_DARK_BLUE displayNameFormat: PERSON_FIRST_THEN_LAST_NAME cdpEnabled: false defaultLoggingLevel: STANDARD dndServicesEnabled: true acd: enabled: true displayCallqueueAgentSoftkeys: LAST_PAGE shortInterdigitTimer: 14 longInterdigitTimer: 16 lineKeyLabelFormat: PERSON_EXTENSION lineKeyLEDPattern: DEFAULT lldpEnabled: false mppUserWebAccessEnabled: true multicast: - 192.86.108.226:22 enhancedMulticast: xmlAppUrl: http://127.0.0.1:8080/ multicastList: - hostAndPort: 224.0.0.0:22 hasXmlAppUrl: true xmlAppTimeout: 10 offHookTimer: 30 phoneLanguage: RUSSIAN poeMode: MAXIMUM qosEnabled: true screenTimeout: enabled: true value: 400 usbPortsEnabled: true vlan: enabled: false value: 1 pcPort: 1 wifiNetwork: enabled: false authenticationMethod: PSK ssidName: my_wifi_network userId: test-user callHistory: LOCAL_CALL_HISTORY contacts: WEBEX_DIRECTORY webexMeetingsEnabled: false usbPorts: enabled: true sideUsbEnabled: true rearUsbEnabled: true volumeSettings: ringerVolume: 9 speakerVolume: 9 handsetVolume: 9 headsetVolume: 9 eHookEnabled: false allowEndUserOverrideEnabled: false httpProxy: mode: 'OFF' autoDiscoveryEnabled: false host: localhost port: '8080' packUrl: www.webex.com authSettingsEnabled: true username: usernamecpi bluetooth: enabled: true mode: PHONE passThroughPortEnabled: true userPasswordOverrideEnabled: true activeCallFocusEnabled: true peerFirmwareEnabled: true noiseCancellation: enabled: false allowEndUserOverrideEnabled: false dialAssistEnabled: true callsPerLine: 8 nightlyResyncEnabled: true missedCallNotificationEnabled: false softKeyLayout: softKeyMenu: idleKeyList: abcdefgh offHookKeyList: nmhsdjs dialingInputKeyList: djsks progressingKeyList: sdsd connectedKeyList: ssdds connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: abcdef startConferenceKeyList: abcdef conferencingKeyList: abcdef releasingKeyList: abcdef holdKeyList: abcdef ringingKeyList: abcdef sharedActiveKeyList: abcdef sharedHeldKeyList: abcdef psk: psk1: abcdef psk2: abcdef psk3: abcdef psk4: abcdef psk5: abcdef psk6: abcdef psk7: abcdef psk8: abcdef psk9: abcdef psk10: abcdef psk11: abcdef psk12: abcdef psk13: abcdef psk14: abcdef psk15: abcdef psk16: veeresh softKeyMenuDefaults: idleKeyList: guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages offHookKeyList: endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7 dialingInputKeyList: dial|1;cancel|2;delchar|3;left|5;right|6 progressingKeyList: endcall|2 connectedKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: endcall|2;xfer|3 startConferenceKeyList: endcall|2;conf|3 conferencingKeyList: endcall;join;crdstart;crdstop;crdpause;crdresume releasingKeyList: endcall|2 holdKeyList: resume|1;endcall|2;newcall|3;redial|4;dir|5 ringingKeyList: answer|1;ignore|2 sharedActiveKeyList: newcall|1;psk1|2;dir|3;back|4 sharedHeldKeyList: resume|1;dir|4 pskDefaults: psk1: fnc=sd;ext=*11;nme=Call Pull backgroundImage8875: BLUE_LIGHT backlightTimer68XX78XX: THIRTY_SEC allowMonitorLinesEnabled: false voiceFeedbackAccessibilityEnabled: false iceEnabled: true cfExpandedSoftKey: ONLY_THE_CALL_FORWARD_ALL wifi: audioCodecPriority: selection: REGIONAL primary: OPUS secondary: G722 tertiary: G711u ldap: {} webAccess: enabled: false customEnabled: true updateInProgress: true deviceCount: 9 lastUpdateTime: 1659624763665 '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 Device Settings operationId: getDeviceSettings description: 'Get override settings for a device. Device settings lists all the applicable settings for MPP, ATA and Wifi devices at the device level. An admin can also modify the settings. DECT devices do not support settings at the device level. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Settings on the device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: deviceModel in: query description: The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model. example: DMS Cisco 8811 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 device settings operationId: updateDeviceSettings description: 'Modify override settings for a device. Device settings list all the applicable settings for an MPP and an ATA devices at the device level. Admins can also modify the settings. NOTE: DECT devices do not support settings at the device level. Updating settings on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvMzAwMmViYmYtYjE1Zi00NTg5LWFjYmUtZGY2NzkwNzE1OTVh schema: type: string - name: orgId in: query description: Organization in which the device resides.. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: deviceModel in: query description: The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model. example: DMS Cisco 8811 schema: type: string requestBody: content: application/json: example: customizations: mpp: pnacEnabled: true audioCodecPriority: primary: OPUS secondary: G722 tertiary: G711u selection: CUSTOM backlightTimerOldModel: THIRTY_SECONDS background: customUrl: '' image: WEBEX_DARK_BLUE displayNameFormat: PERSON_FIRST_THEN_LAST_NAME cdpEnabled: false defaultLoggingLevel: DEBUGGING dndServicesEnabled: true acd: enabled: true displayCallqueueAgentSoftkeys: LAST_PAGE shortInterdigitTimer: 14 longInterdigitTimer: 16 lineKeyLabelFormat: PERSON_EXTENSION lineKeyLEDPattern: DEFAULT lldpEnabled: false mppUserWebAccessEnabled: true multicast: - 192.86.108.226:2223 enhancedMulticast: xmlAppUrl: http://127.0.0.1:8080/ multicastList: - hostAndPort: 224.0.0.0:22 hasXmlAppUrl: true xmlAppTimeout: 10 offHookTimer: 30 phoneLanguage: RUSSIAN poeMode: MAXIMUM qosEnabled: true screenTimeout: enabled: true value: 400 usbPortsEnabled: true vlan: enabled: false value: 1 pcPort: 1 wifiNetwork: enabled: false authenticationMethod: PSK ssidName: my_wifi_network userId: test-user backlightTimer: FIVE_MIN callHistory: LOCAL_CALL_HISTORY contacts: WEBEX_DIRECTORY webexMeetingsEnabled: false usbPorts: enabled: true sideUsbEnabled: true rearUsbEnabled: true volumeSettings: ringerVolume: 9 speakerVolume: 9 handsetVolume: 9 headsetVolume: 9 eHookEnabled: false allowEndUserOverrideEnabled: false httpProxy: mode: 'OFF' autoDiscoveryEnabled: false host: localhost port: '8080' packUrl: www.webex.com authSettingsEnabled: true username: usernamecpi bluetooth: enabled: true mode: PHONE passThroughPortEnabled: true userPasswordOverrideEnabled: true activeCallFocusEnabled: true peerFirmwareEnabled: true noiseCancellation: enabled: false allowEndUserOverrideEnabled: false dialAssistEnabled: true callsPerLine: 8 nightlyResyncEnabled: true missedCallNotificationEnabled: false softKeyLayout: softKeyMenu: idleKeyList: abcdefgh offHookKeyList: nmhsdjs dialingInputKeyList: djsks progressingKeyList: sdsd connectedKeyList: ssdds connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: abcdef startConferenceKeyList: abcdef conferencingKeyList: abcdef releasingKeyList: abcdef holdKeyList: abcdef ringingKeyList: abcdef sharedActiveKeyList: abcdef sharedHeldKeyList: abcdef psk: psk1: abcdef psk2: abcdef psk3: abcdef psk4: abcdef psk5: abcdef psk6: abcdef psk7: abcdef psk8: abcdef psk9: abcdef psk10: abcdef psk11: abcdef psk12: abcdef psk13: abcdef psk14: abcdef psk15: abcdef psk16: veeresh softKeyMenuDefaults: idleKeyList: guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages offHookKeyList: endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7 dialingInputKeyList: dial|1;cancel|2;delchar|3;left|5;right|6 progressingKeyList: endcall|2 connectedKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: endcall|2;xfer|3 startConferenceKeyList: endcall|2;conf|3 conferencingKeyList: endcall;join;crdstart;crdstop;crdpause;crdresume releasingKeyList: endcall|2 holdKeyList: resume|1;endcall|2;newcall|3;redial|4;dir|5 ringingKeyList: answer|1;ignore|2 sharedActiveKeyList: newcall|1;psk1|2;dir|3;back|4 sharedHeldKeyList: resume|1;dir|4 pskDefaults: psk1: fnc=sd;ext=*11;nme=Call Pull backgroundImage8875: BLUE_LIGHT backlightTimer68XX78XX: THIRTY_SEC allowMonitorLinesEnabled: false voiceFeedbackAccessibilityEnabled: false iceEnabled: true cfExpandedSoftKey: ONLY_THE_CALL_FORWARD_ALL wifi: audioCodecPriority: selection: REGIONAL primary: OPUS secondary: G722 tertiary: G711u ldap: {} webAccess: enabled: false customEnabled: true updateInProgress: true deviceCount: 9 lastUpdateTime: 1659624763665 schema: $ref: '#/components/schemas/PutDeviceSettingsRequest' /telephony/config/locations/{locationId}/devices/settings: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DeviceSettingsObject' example: customizations: ata: audioCodecPriority: selection: REGIONAL primary: G711a secondary: G711u tertiary: G729a ataDtmfMode: STRICT ataDtmfMethod: AVT cdpEnabled: true lldpEnabled: true qosEnabled: true vlan: enabled: true value: 1 webAccessEnabled: true nightlyResyncEnabled: true snmp: enabled: false trustedIP: 0.0.0.0/0.0.0.0 getCommunity: public setCommunity: private snmpV3Enabled: false mpp: pnacEnabled: true audioCodecPriority: selection: CUSTOM primary: OPUS secondary: G722 tertiary: G711u backlightTimer: ONE_M background: customUrl: '' image: WEBEX_DARK_BLUE displayNameFormat: PERSON_FIRST_THEN_LAST_NAME cdpEnabled: false defaultLoggingLevel: STANDARD dndServicesEnabled: true acd: enabled: true displayCallqueueAgentSoftkeys: LAST_PAGE shortInterdigitTimer: 14 longInterdigitTimer: 16 lineKeyLabelFormat: PERSON_EXTENSION lineKeyLEDPattern: DEFAULT lldpEnabled: false mppUserWebAccessEnabled: true multicast: - 192.86.108.226:22 enhancedMulticast: xmlAppUrl: http://127.0.0.1:8080/ multicastList: - hostAndPort: 224.0.0.0:22 hasXmlAppUrl: true xmlAppTimeout: 10 offHookTimer: 30 phoneLanguage: RUSSIAN poeMode: MAXIMUM qosEnabled: true screenTimeout: enabled: true value: 400 usbPortsEnabled: true vlan: enabled: false value: 1 pcPort: 1 wifiNetwork: enabled: false authenticationMethod: PSK ssidName: my_wifi_network userId: test-user callHistory: LOCAL_CALL_HISTORY contacts: WEBEX_DIRECTORY webexMeetingsEnabled: false usbPorts: enabled: true sideUsbEnabled: true rearUsbEnabled: true volumeSettings: ringerVolume: 9 speakerVolume: 9 handsetVolume: 9 headsetVolume: 9 eHookEnabled: false allowEndUserOverrideEnabled: false httpProxy: mode: 'OFF' autoDiscoveryEnabled: false host: localhost port: '8080' packUrl: www.webex.com authSettingsEnabled: true username: usernamecpi bluetooth: enabled: true mode: PHONE passThroughPortEnabled: true userPasswordOverrideEnabled: true activeCallFocusEnabled: true peerFirmwareEnabled: true noiseCancellation: enabled: false allowEndUserOverrideEnabled: false dialAssistEnabled: true callsPerLine: 8 nightlyResyncEnabled: true missedCallNotificationEnabled: false softKeyLayout: softKeyMenu: idleKeyList: abcdefgh offHookKeyList: nmhsdjs dialingInputKeyList: djsks progressingKeyList: sdsd connectedKeyList: ssdds connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: abcdef startConferenceKeyList: abcdef conferencingKeyList: abcdef releasingKeyList: abcdef holdKeyList: abcdef ringingKeyList: abcdef sharedActiveKeyList: abcdef sharedHeldKeyList: abcdef psk: psk1: abcdef psk2: abcdef psk3: abcdef psk4: abcdef psk5: abcdef psk6: abcdef psk7: abcdef psk8: abcdef psk9: abcdef psk10: abcdef psk11: abcdef psk12: abcdef psk13: abcdef psk14: abcdef psk15: abcdef psk16: veeresh softKeyMenuDefaults: idleKeyList: guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages offHookKeyList: endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7 dialingInputKeyList: dial|1;cancel|2;delchar|3;left|5;right|6 progressingKeyList: endcall|2 connectedKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: endcall|2;xfer|3 startConferenceKeyList: endcall|2;conf|3 conferencingKeyList: endcall;join;crdstart;crdstop;crdpause;crdresume releasingKeyList: endcall|2 holdKeyList: resume|1;endcall|2;newcall|3;redial|4;dir|5 ringingKeyList: answer|1;ignore|2 sharedActiveKeyList: newcall|1;psk1|2;dir|3;back|4 sharedHeldKeyList: resume|1;dir|4 pskDefaults: psk1: fnc=sd;ext=*11;nme=Call Pull backgroundImage8875: BLUE_LIGHT backlightTimer68XX78XX: THIRTY_SEC allowMonitorLinesEnabled: false voiceFeedbackAccessibilityEnabled: false iceEnabled: true cfExpandedSoftKey: ONLY_THE_CALL_FORWARD_ALL wifi: audioCodecPriority: selection: REGIONAL primary: OPUS secondary: G722 tertiary: G711u ldap: {} webAccess: enabled: false customEnabled: false updateInProgress: true deviceCount: 9 lastUpdateTime: 1659624763665 '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 Location Device Settings operationId: getLocationDeviceSettings description: 'Get device override settings for a location. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw schema: type: string - name: orgId in: query description: Organization in which the device resides. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/{deviceId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetThirdPartyDeviceObject' example: managedBy: CUSTOMER owner: sipUserName: '392829' linePort: i6i1ar1v29@98079822.int10.bcld.webex.com proxy: outboundProxy: hs17.hosted-int.bcld.webex.com manufacturer: THIRD_PARTY id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3 ip: 100.110.120.130 mac: 11223344AAFF model: DMS Cisco 8811 activationState: activated description: - your tag - device tag upgradeChannelEnabled: 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 Webex Calling Device Details operationId: getWebexCallingDeviceDetails description: '
Not supported for Webex for Government (FedRAMP)
Retrieves Webex Calling device details that include information needed for third-party device management. Webex calling devices are associated with a specific user Workspace or Virtual Line. Webex Calling devices share the location with the entity that owns them. Person or workspace to which the device is assigned. Its fields point to a primary line/port of the device. Requires a full, location, user, or read-only admin auth token with the scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: ID of the organization in which the device resides. 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 Third Party Device operationId: updateThirdPartyDevice description: '
Not supported for Webex for Government (FedRAMP)
Modify a device''s `sipPassword`. Updating `sipPassword` on the device requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: ID of the organization in which the device resides. example: Y2lzY29zcGFyazovL3VzL0NBTExJTkdfREVWSUNFLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw schema: type: string requestBody: content: application/json: example: sipPassword: Test4Password123& schema: $ref: '#/components/schemas/PutThirdPartyDevice' /telephony/config/people/{personId}/devices: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/deviceList' example: devices: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= descriptions: - Your tag - John Doe (Cisco 8875) model: DMS Cisco 8875 modelType: MPP mac: 52EAD324FD21 ipAddress: 10.201.128.187 displayName: Cisco 8875 primaryOwner: true type: PRIMARY hoteling: enabled: true limitGuestUse: true guestHoursLimit: 5 owner: id: Y2lzY29zcGFyazovL3VzL1BFUlNPTi81NzU2YWE1Yy03YjQ0LTQ3MjQtOGQ3ZS03NDE1MGVjODc4YmQ type: PEOPLE firstName: John lastName: Doe maxDeviceCount: 1 maxOwnedDeviceCount: 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 Person Devices operationId: getPersonDevices description: 'Get all devices for a person. This requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: personId in: path description: Person for whom to retrieve devices. required: true example: Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M schema: type: string - name: orgId in: query description: Organization to which the person belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/people/{personId}/devices/settings/hoteling: 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 Hoteling Settings for a Person's Primary Devices operationId: modefyHotelingSettingsForPersonsPrimaryDevices description: 'Modify hoteling login configuration on a person''s Webex Calling Devices which are in effect when the device is the user''s primary device and device type is PRIMARY. To view the current hoteling login settings, see the `hoteling` field in [Get Person Devices](/docs/api/v1/device-call-settings/get-person-devices). Modifying devices for a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: personId in: path description: ID of the person associated with the device. required: true example: Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M schema: type: string - name: orgId in: query description: Organization to which the person belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: hoteling: enabled: true limitGuestUse: true guestHoursLimit: 5 schema: $ref: '#/components/schemas/UserHotelingRequestPatch' /telephony/config/workspaces/{workspaceId}/devices: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/placeDeviceList' example: devices: - id: Y2lzY29zcGFyazovL3VzL0RFVklDRS81NzU2YWE1Yy1jODc4LTQ3MjQtOGQ3ZS03NDE1MGU3YjQ0YmQ descriptions: - Your tag - John Doe (Cisco 8875) model: DMS Cisco 8875 mac: 52EAD324FD21 ipAddress: 10.201.128.187 displayName: Cisco 8875 primaryOwner: true type: PRIMARY hoteling: enabled: true limitGuestUse: true guestHoursLimit: 24 owner: id: Y2lzY29zcGFyazovL3VzL1BFUlNPTi81NzU2YWE1Yy03YjQ0LTQ3MjQtOGQ3ZS03NDE1MGVjODc4YmQ type: PEOPLE firstName: John lastName: Doe maxDeviceCount: 1 maxOwnedDeviceCount: 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 Workspace Devices operationId: getWorkspaceDevices description: 'Get all devices for a workspace. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: workspaceId in: path description: ID of the workspace for which to retrieve devices. required: true example: Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M schema: type: string - name: orgId in: query description: Organization to which the workspace belongs. 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: Modify Workspace Devices operationId: modifyWorkspaceDevices description: 'Modify devices for a workspace. Modifying devices for a workspace requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: workspaceId in: path description: ID of the workspace for which to modify devices. required: true example: Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M schema: type: string - name: orgId in: query description: Organization to which the workspace belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true limitGuestUse: true guestHoursLimit: 24 schema: $ref: '#/components/schemas/HotelingRequest' /telephony/config/devices/settings: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListDeviceSettingsObject' example: customizations: ata: audioCodecPriority: selection: REGIONAL primary: G711a secondary: G711u tertiary: G729a ataDtmfMode: STRICT ataDtmfMethod: AVT cdpEnabled: true lldpEnabled: true qosEnabled: true vlan: enabled: true value: 1 webAccessEnabled: true nightlyResyncEnabled: true snmp: enabled: false trustedIP: 0.0.0.0/0.0.0.0 getCommunity: public setCommunity: private snmpV3Enabled: false dect: audioCodecPriority: selection: REGIONAL primary: G729 secondary: G711u tertiary: G711a cdpEnabled: true lldpEnabled: true qosEnabled: true vlan: enabled: false value: 0 webAccessEnabled: true nightlyResyncEnabled: true mpp: pnacEnabled: true audioCodecPriority: selection: CUSTOM primary: OPUS secondary: G722 tertiary: G711u backlightTimer: ONE_MIN background: customUrl: '' image: WEBEX_DARK_BLUE displayNameFormat: PERSON_FIRST_THEN_LAST_NAME cdpEnabled: false defaultLoggingLevel: STANDARD dndServicesEnabled: true acd: enabled: true displayCallqueueAgentSoftkeys: LAST_PAGE shortInterdigitTimer: 14 longInterdigitTimer: 16 lineKeyLabelFormat: PERSON_EXTENSION lineKeyLEDPattern: DEFAULT lldpEnabled: false mppUserWebAccessEnabled: true multicast: - 192.86.108.226:22 enhancedMulticast: xmlAppUrl: http://127.0.0.1:8080/ multicastList: - hostAndPort: 224.0.0.0:22 hasXmlAppUrl: true xmlAppTimeout: 10 offHookTimer: 30 phoneLanguage: RUSSIAN poeMode: MAXIMUM qosEnabled: true screenTimeout: enabled: true value: 400 usbPortsEnabled: true vlan: enabled: false value: 1 pcPort: 1 wifiNetwork: enabled: false authenticationMethod: PSK ssidName: my_wifi_network userId: test-user callHistory: LOCAL_CALL_HISTORY contacts: WEBEX_DIRECTORY webexMeetingsEnabled: false usbPorts: enabled: true sideUsbEnabled: true rearUsbEnabled: true volumeSettings: ringerVolume: 9 speakerVolume: 9 handsetVolume: 9 headsetVolume: 9 eHookEnabled: false allowEndUserOverrideEnabled: false httpProxy: mode: 'OFF' autoDiscoveryEnabled: false host: localhost port: '8080' packUrl: www.webex.com authSettingsEnabled: true username: usernamecpi bluetooth: enabled: true mode: PHONE passThroughPortEnabled: true userPasswordOverrideEnabled: true activeCallFocusEnabled: true peerFirmwareEnabled: true noiseCancellation: enabled: false allowEndUserOverrideEnabled: false dialAssistEnabled: true callsPerLine: 8 nightlyResyncEnabled: true missedCallNotificationEnabled: false softKeyLayout: softKeyMenu: idleKeyList: abcdefgh offHookKeyList: nmhsdjs dialingInputKeyList: djsks progressingKeyList: sdsd connectedKeyList: ssdds connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: abcdef startConferenceKeyList: abcdef conferencingKeyList: abcdef releasingKeyList: abcdef holdKeyList: abcdef ringingKeyList: abcdef sharedActiveKeyList: abcdef sharedHeldKeyList: abcdef psk: psk1: abcdef psk2: abcdef psk3: abcdef psk4: abcdef psk5: abcdef psk6: abcdef psk7: abcdef psk8: abcdef psk9: abcdef psk10: abcdef psk11: abcdef psk12: abcdef psk13: abcdef psk14: abcdef psk15: abcdef psk16: veeresh softKeyMenuDefaults: idleKeyList: guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages offHookKeyList: endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7 dialingInputKeyList: dial|1;cancel|2;delchar|3;left|5;right|6 progressingKeyList: endcall|2 connectedKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume connectedVideoKeyList: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume startTransferKeyList: endcall|2;xfer|3 startConferenceKeyList: endcall|2;conf|3 conferencingKeyList: endcall;join;crdstart;crdstop;crdpause;crdresume releasingKeyList: endcall|2 holdKeyList: resume|1;endcall|2;newcall|3;redial|4;dir|5 ringingKeyList: answer|1;ignore|2 sharedActiveKeyList: newcall|1;psk1|2;dir|3;back|4 sharedHeldKeyList: resume|1;dir|4 pskDefaults: psk1: fnc=sd;ext=*11;nme=Call Pull backgroundImage8875: BLUE_LIGHT backlightTimer68XX78XX: THIRTY_SEC allowMonitorLinesEnabled: false voiceFeedbackAccessibilityEnabled: false iceEnabled: true wifi: audioCodecPriority: selection: REGIONAL primary: OPUS secondary: G722 tertiary: G711u ldap: {} webAccess: enabled: false updateInProgress: false deviceCount: 22 lastUpdateTime: 1659624763665 '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 the device override settings for a organization operationId: readDeviceOverrideSettingsForOrganization description: 'Get device override settings for an organization. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: List supported devices for an organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/lineKeyTemplates: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9lYzVmMjg0Ni1iMDQ2LTQ5OGEtOWU2Mi04ZTg4ZWFlZmQyMGQ description: ID of the newly created Line Key Template. example: id: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9lYzVmMjg0Ni1iMDQ2LTQ5OGEtOWU2Mi04ZTg4ZWFlZmQyMGQ '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 Line Key Template operationId: createLineKeyTemplate description: 'Create a Line Key Template in this organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows customers to create a `Line Key Template` for a device model. Creating a Line Key Template requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Organization to which the line key template belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: templateName: My Template deviceModel: DMS Cisco 8851 userReorderEnabled: true lineKeys: - lineKeyIndex: 1 lineKeyType: PRIMARY_LINE - lineKeyIndex: 2 lineKeyType: SPEED_DIAL lineKeyLabel: Help Line lineKeyValue: '3568' - lineKeyIndex: 3 lineKeyType: SHARED_LINE sharedLineIndex: 1 schema: $ref: '#/components/schemas/PostLineKeyTemplateRequest' get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - lineKeyTemplates properties: lineKeyTemplates: type: array items: $ref: '#/components/schemas/lineKeyTemplatesResponse' description: Array of Line Key Templates. example: lineKeyTemplates: - id: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9lYzVmMjg0Ni1iMDQ2LTQ5OGEtOWU2Mi04ZTg4ZWFlZmQyMGQ templateName: template-for-8845 deviceModel: DMS Cisco 8845 modelDisplayName: Cisco 8845 '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 the list of Line Key Templates operationId: readListOfLineKeyTemplates description: 'List all Line Key Templates available for this organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to retrieve the list of Line Key Templates that are available for the organization. Retrieving this list requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: List line key templates for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/lineKeyTemplates/{templateId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLineKeyTemplateResponse' example: id: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM templateName: My Template deviceModel: DMS Cisco 8851 modelDisplayName: Cisco 8851 userReorderEnabled: true lineKeys: - lineKeyIndex: 1 lineKeyType: PRIMARY_LINE - lineKeyIndex: 2 lineKeyType: SPEED_DIAL lineKeyLabel: Home lineKeyValue: '2891' - lineKeyIndex: 3 lineKeyType: SHARED_LINE sharedLineIndex: 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 details of a Line Key Template operationId: getDetailsOfLineKeyTemplate description: 'Get detailed information about a Line Key Template by template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to retrieve a line key template by its ID in an organization. Retrieving a line key template requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: templateId in: path description: Get line key template for this template ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM schema: type: string - name: orgId in: query description: Retrieve a line key template for this 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: Modify a Line Key Template operationId: modifyLineKeyTemplate description: 'Modify a Line Key Template by its template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to modify an existing Line Key Template by its ID in an organization. Modifying an existing Line Key Template requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: templateId in: path description: Modify line key template with this template ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM schema: type: string - name: orgId in: query description: Modify a line key template for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: userReorderEnabled: true lineKeys: - lineKeyIndex: 1 lineKeyType: PRIMARY_LINE - lineKeyIndex: 2 lineKeyType: SPEED_DIAL lineKeyLabel: Office lineKeyValue: '4850' - lineKeyIndex: 3 lineKeyType: SHARED_LINE sharedLineIndex: 1 schema: $ref: '#/components/schemas/PutLineKeyTemplateRequest' 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 Line Key Template operationId: deleteLineKeyTemplate description: 'Delete a Line Key Template by its template ID in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to delete an existing Line Key Templates by its ID in an organization. Deleting an existing line key template requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: templateId in: path description: Delete line key template with this template ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM schema: type: string - name: orgId in: query description: Delete a line key template for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/actions/previewApplyLineKeyTemplate/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - deviceCount properties: deviceCount: type: number description: Number of devices affected. example: deviceCount: 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: Preview Apply Line Key Template operationId: previewApplyLineKeyTemplate description: 'Preview the number of devices that will be affected by the application of a Line Key Template or when resetting devices to their factory Line Key settings. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to preview the number of devices that will be affected if a customer were to apply a Line Key Template or apply factory default Line Key settings to devices. Retrieving the number of devices affected requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Preview Line Key Template for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: action: APPLY_TEMPLATE templateId: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ locationIds: - Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA excludeDevicesWithCustomLayout: true includeDeviceTags: - accounting - sales excludeDeviceTags: - admin advisoryTypes: moreSharedAppearancesEnabled: true fewSharedAppearancesEnabled: true moreMonitorAppearancesEnabled: 'true' moreCPEAppearancesEnabled: 'true' moreModeManagementAppearancesEnabled: true schema: $ref: '#/components/schemas/PostApplyLineKeyTemplateRequest' /telephony/config/jobs/devices/applyLineKeyTemplate: post: responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplyLineKeyTemplateJobDetails' example: name: applyphonelinekeytemplates id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: STARTED exitCode: UNKNOWN createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: STARTED exitCode: UNKNOWN name: applyphonelinekeytemplatesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: STARTED latestExecutionExitCode: UNKNOWN percentageComplete: 10 updatedCount: 1 advisoryCount: 0 '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: Apply a Line Key Template operationId: applyLineKeyTemplate description: 'Apply a Line Key Template or reset devices to their factory Line Key settings. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to apply a line key template or apply factory default Line Key settings to devices in a set of locations or across all locations in the organization. Applying a Line Key Template or resetting devices to their default Line Key configuration requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Apply Line Key Template for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: action: APPLY_TEMPLATE templateId: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ locationIds: - Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA excludeDevicesWithCustomLayout: true includeDeviceTags: - accounting - sales excludeDeviceTags: - admin advisoryTypes: moreSharedAppearancesEnabled: true fewSharedAppearancesEnabled: true moreMonitorAppearancesEnabled: 'true' moreCPEAppearancesEnabled: 'true' moreModeManagementAppearancesEnabled: true schema: $ref: '#/components/schemas/PostApplyLineKeyTemplateRequest' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplyLineKeyTemplateJobList' example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' endTime: '2023-07-05T21:37:06.105Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' endTime: '2023-07-05T21:37:06.077Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: COMPLETED exitCode: COMPLETED name: applyphonelinekeytemplatesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED percentageComplete: 100 updatedCount: 1 advisoryCount: 0 '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 List of Apply Line Key Template jobs operationId: getListOfApplyLineKeyTemplatesJobs description: 'Get the list of all apply line key templates jobs in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to retrieve all the apply line key templates jobs in an organization. Retrieving the list of apply line key templates jobs in an organization requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Retrieve list of line key templates jobs in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplyLineKeyTemplateJobDetails' example: name: applyphonelinekeytemplates id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' endTime: '2023-07-05T21:37:06.105Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' endTime: '2023-07-05T21:37:06.077Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: COMPLETED exitCode: COMPLETED name: applyphonelinekeytemplatesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED percentageComplete: 100 updatedCount: 1 advisoryCount: 0 '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 job status of an Apply Line Key Template job operationId: getTheJobStatusOfAnApplyLineKeyTemplateJob description: 'Get the status of an apply line key template job by its job ID. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to check the status of an apply line key templates job by job ID in an organization. Checking the the status of an apply line key templates job in an organization requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job status for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string - name: orgId in: query description: Check a line key template job status in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}/errors: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ApplyLineKeyTemplateJobErrors' example: error: key: '500' message: - description: null code: BATCH-0 locationId: null trackingId: NA_b5352f89-dee8-4eca-bb6f-edabfb175688 '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 job errors for an Apply Line Key Template job operationId: getJobErrorsForApplyLineKeyTemplateJob description: 'GET job errors for an apply Line Key Template job in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display. A Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model. This API allows users to retrieve all the errors of an apply line key templates job by job ID in an organization. Retrieving all the errors of an apply line key templates job in an organization requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job errors for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string - name: orgId in: query description: Retrieve list of errors for an apply line key template job in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/dects/supportedDevices: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListDectDeviceType' example: devices: - model: DMS Cisco DBS110 displayName: Cisco DECT 110 Base numberOfBaseStations: 2 numberOfLinePorts: 20 numberOfRegistrationsSupported: 10 - model: DMS Cisco DBS210 displayName: Cisco DECT 210 Base numberOfBaseStations: 250 numberOfLinePorts: 1000 numberOfRegistrationsSupported: 30 '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 the DECT device type list - Deprecated operationId: readTheDectDeviceTypeListDeprecated description: '
Not supported for Webex for Government (FedRAMP).
The REST path for this API has changed to [GET /telephony/config/devices/dectNetworks/supportedDevices{?orgId}]. The use of this old REST path is deprecated and will be decommissioned on October 10, 2024. Please start using it for all future projects.
Get DECT device type list with base stations and line ports supported count. This is a static list. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: '' example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/dectNetworks/supportedDevices: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListDectDeviceType' example: devices: - model: DMS Cisco DBS110 displayName: Cisco DECT 110 Base numberOfBaseStations: 2 numberOfLinePorts: 20 numberOfRegistrationsSupported: 10 - model: DMS Cisco DBS210 displayName: Cisco DECT 210 Base numberOfBaseStations: 250 numberOfLinePorts: 1000 numberOfRegistrationsSupported: 30 '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 the DECT device type list operationId: readTheDectDeviceTypeList description: '
Not supported for Webex for Government (FedRAMP).
Get DECT device type list with base stations and line ports supported count. This is a static list. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: '' example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/actions/validateMacs/invoke: post: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/MACAddressResponse' example: status: ERRORS macStatus: - mac: ab125678cdef state: AVAILABLE - mac: 00005E0053B4 state: UNAVAILABLE errorCode: 5675 message: '[Error 5675] MAC Address is in use.' '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: Validate a list of MAC address operationId: validateAListOfMACAddress description: 'Validate a list of MAC addresses. Validating this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Validate the mac address(es) for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: macs: - ab125678cdef - 00005E0053B4 schema: $ref: '#/components/schemas/ValidateMACRequest' /telephony/config/jobs/devices/callDeviceSettings: post: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/StartJobResponse' example: name: calldevicesettings id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ jobType: calldevicesettings trackingId: ROUTER_62F66055-8D70-01BB-0137-AC10A8310137 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 235142 jobExecutionStatus: - id: 235842 lastUpdated: '2022-08-12T14:15:14.591Z' statusMessage: STARTING exitCode: UNKNOWN createdTime: '2022-08-12T14:15:14.591Z' timeElapsed: PT0S latestExecutionStatus: STARTING latestExecutionExitCode: UNKNOWN locationCustomizationsEnabled: false target: CUSTOMER locationId: '' percentageComplete: 0 '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: Change Device Settings Across Organization Or Location Job operationId: changeDeviceSettingsAcrossOrganizationOrLocationJob description: 'Change device settings across organization or locations jobs. Performs bulk and asynchronous processing for all types of device settings initiated by organization and system admins in a stateful persistent manner. This job will modify the requested device settings across all the devices. Whenever a location ID is specified in the request, it will modify the requested device settings only for the devices that are part of the provided location within an organization. Returns a unique job ID which can then be utilized further to retrieve status and errors for the same. Only one job per customer can be running at any given time within the same organization. An attempt to run multiple jobs at the same time will result in a 409 error response. Running a job requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Apply change device settings for all the devices under this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA locationCustomizationsEnabled: true customizations: ata: audioCodecPriority: primary: G711a secondary: G711u tertiary: G729a selection: REGIONAL ataDtmfMode: NORMAL ataDtmfMethod: AVT cdpEnabled: true lldpEnabled: true qosEnabled: true vlan: enabled: true value: 1 dect: audioCodecPriority: primary: G729 secondary: G711u tertiary: G711a selection: REGIONAL cdpEnabled: true lldpEnabled: false multicast: [] qosEnabled: true vlan: enabled: false value: null mpp: pnacEnabled: true audioCodecPriority: primary: OPUS secondary: G722 tertiary: G711u selection: CUSTOM backlightTimer: FIVE_M background: customUrl: '' image: NONE displayNameFormat: PERSON_FIRST_THEN_LAST_NAME cdpEnabled: false dndServicesEnabled: true acd: enabled: false displayCallqueueAgentSoftkeys: LAST_PAGE shortInterdigitTimer: 14 longInterdigitTimer: 16 lineKeyLabelFormat: PERSON_FIRST_THEN_LAST_NAME lineKeyLEDPattern: DEFAULT lldpEnabled: false mppUserWebAccessEnabled: true multicast: [] enhancedMulticast: xmlAppUrl: http://127.0.0.1:8080/ multicastList: - hostAndPort: 224.0.0.0:22 hasXmlAppUrl: true xmlAppTimeout: 10 offHookTimer: 30 phoneLanguage: DANISH poeMode: MAXIMUM qosEnabled: true screenTimeout: enabled: true value: 400 usbPortsEnabled: true vlan: enabled: false value: 1 pcPort: 1 wifiNetwork: enabled: false authenticationMethod: PSK ssidName: test_wifi_network userId: test allowMonitorLinesEnabled: false iceEnabled: true cfExpandedSoftKey: ONLY_THE_CALL_FORWARD_ALL schema: $ref: '#/components/schemas/AdminBatchStartJobObjectLocationCustomizations' get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobListResponse' example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ jobType: calldevicesettings trackingId: ATLAS_89144033-afb5-44e8-bae8-946e84c71fa3_0 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 235690 jobExecutionStatus: - id: 236410 startTime: '2022-08-15T12:54:50.380Z' endTime: '2022-08-15T12:55:01.833Z' lastUpdated: '2022-08-15T12:55:02.160Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2022-08-15T12:54:50.350Z' stepExecutionStatuses: - id: 1159389 startTime: '2022-08-15T12:54:50.433Z' endTime: '2022-08-15T12:55:01.826Z' lastUpdated: '2022-08-15T12:55:01.826Z' statusMessage: COMPLETED exitCode: COMPLETED name: calldevicesettingsOverrideProcess timeElapsed: PT11.393S timeElapsed: PT11.393S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED locationCustomizationsEnabled: false target: CUSTOMER locationId: '' percentageComplete: 100 deviceCount: 23 '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 Change Device Settings Jobs operationId: listChangeDeviceSettingsJobs description: 'List change device settings jobs. Lists all the jobs for jobType `calldevicesettings` for the given organization in order of most recent one to oldest one 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: - Device Call Settings parameters: - name: orgId in: query description: Retrieve list of 'calldevicesettings' jobs for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Start at the zero-based offset in the list of jobs. Default is 0. example: '0' schema: type: number - name: max in: query description: Limit the number of jobs returned to this maximum count. Default is 2000. example: '100' schema: type: number /telephony/config/jobs/devices/callDeviceSettings/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/jobIdResponseObject' example: name: calldevicesettings id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ jobType: calldevicesettings trackingId: ATLAS_89144033-afb5-44e8-bae8-946e84c71fa3_0 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 235690 jobExecutionStatus: - id: 236410 startTime: '2022-08-15T12:54:50.380Z' endTime: '2022-08-15T12:55:01.833Z' lastUpdated: '2022-08-15T12:55:02.160Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2022-08-15T12:54:50.350Z' stepExecutionStatuses: - id: 1159389 startTime: '2022-08-15T12:54:50.433Z' endTime: '2022-08-15T12:55:01.826Z' lastUpdated: '2022-08-15T12:55:01.826Z' statusMessage: COMPLETED exitCode: COMPLETED name: calldevicesettingsOverrideProcess timeElapsed: PT11.393S timeElapsed: PT11.393S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED locationCustomizationsEnabled: false target: CUSTOMER locationId: '' percentageComplete: 100 deviceCount: 23 '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 Change Device Settings Job Status operationId: getChangeDeviceSettingsJobStatus description: 'Get change device settings job status. Provides details of the job with `jobId` of `jobType` `calldevicesettings`. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job details for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ schema: type: string /telephony/config/jobs/devices/callDeviceSettings/{jobId}/errors: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponseObject' example: items: - itemNumber: 0 error: key: '500' message: - description: Unable to trigger device settings override process. code: null location: null trackingId: ROUTER_62F66055-8D70-01BB-0137-AC10A8310137 '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 Change Device Settings Job Errors operationId: listChangeDeviceSettingsJobErrors description: 'List change device settings job errors. Lists all error details of the job with `jobId` of `jobType` `calldevicesettings`. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job details for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ schema: type: string - name: orgId in: query description: Retrieve list of jobs for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Specifies the offset from the first result that you want to fetch. Default is 0. example: '0' schema: type: number - name: max in: query description: Specifies the maximum number of records that you want to fetch. Default is 2000 example: '100' schema: type: number /telephony/config/devices/{deviceId}/layout: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DeviceLayout' example: layoutMode: CUSTOM userReorderEnabled: 'true' lineKeys: - lineKeyIndex: 1 lineKeyType: PRIMARY_LINE - lineKeyIndex: 2 lineKeyType: SPEED_DIAL lineKeyLabel: Home lineKeyValue: '213456' kemModuleType: KEM_14_KEYS kemKeys: - kemModuleIndex: 1 kemKeyIndex: 1 kemKeyType: CLOSED - kemModuleIndex: 1 kemKeyIndex: 2 kemKeyType: SPEED_DIAL kemKeyLabel: Office kemKeyValue: '213457' - kemModuleIndex: 1 kemKeyIndex: 3 kemKeyType: SHARED_LINE sharedLineIndex: 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 Device Layout by Device ID operationId: getDeviceLayoutByDeviceId description: 'Get layout information of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Get device layout for this device ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string - name: orgId in: query description: Retrieve a device layout for the device in this 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: Modify Device Layout by Device ID operationId: modifyDeviceLayoutByDeviceId description: 'Modify the layout of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Modify device layout for this device ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM/ schema: type: string - name: orgId in: query description: Modify a device layout for the device in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: layoutMode: CUSTOM userReorderEnabled: 'true' lineKeys: - lineKeyIndex: 1 lineKeyType: PRIMARY_LINE - lineKeyIndex: 2 lineKeyType: SPEED_DIAL lineKeyLabel: Home lineKeyValue: '213456' kemModuleType: KEM_14_KEYS kemKeys: - kemModuleIndex: 1 kemKeyIndex: 1 kemKeyType: CLOSED - kemModuleIndex: 1 kemKeyIndex: 2 kemKeyType: SPEED_DIAL kemKeyLabel: Office kemKeyValue: '213457' - kemModuleIndex: 1 kemKeyIndex: 3 kemKeyType: SHARED_LINE sharedLineIndex: 1 schema: $ref: '#/components/schemas/DeviceLayout' /telephony/config/jobs/devices/rebuildPhones: post: responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/RebuildPhonesJob' example: name: rebuildphones id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' endTime: '2023-07-05T21:37:06.105Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' endTime: '2023-07-05T21:37:06.077Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: COMPLETED exitCode: COMPLETED name: rebuildphonesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED target: LOCATION locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg percentageComplete: 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: Rebuild Phones Configuration operationId: rebuildPhonesConfiguration description: '
Not supported for Webex for Government (FedRAMP)
. Rebuild all phone configurations for the specified location. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Rebuild phones for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg schema: $ref: '#/components/schemas/RebuildPhonesPostRequest' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RebuildPhonesList' example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' endTime: '2023-07-05T21:37:06.105Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' endTime: '2023-07-05T21:37:06.077Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: COMPLETED exitCode: COMPLETED name: rebuildphonesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED target: LOCATION locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg percentageComplete: 100 deviceCount: 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: List Rebuild Phones Jobs operationId: listRebuildPhonesJobs description: '
Not supported for Webex for Government (FedRAMP)
. Get the list of all Rebuild Phones jobs in an organization. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: List of rebuild phones jobs in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/devices/rebuildPhones/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RebuildPhonesJob' example: id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk trackingId: NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-07-05T21:36:53.749Z' endTime: '2023-07-05T21:37:06.105Z' lastUpdated: '2023-07-05T21:37:06.714Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-07-05T21:36:53.551Z' stepExecutionStatuses: - id: 0 startTime: '2023-07-05T21:36:54.601Z' endTime: '2023-07-05T21:37:06.077Z' lastUpdated: '2023-07-05T21:37:06.078Z' statusMessage: COMPLETED exitCode: COMPLETED name: rebuildphonesProcess timeElapsed: PT11.476S timeElapsed: PT11.476S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED target: LOCATION locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg percentageComplete: 100 deviceCount: 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 the Job Status of a Rebuild Phones Job operationId: getTheJobStatusOfARebuildPhonesJob description: '
Not supported for Webex for Government (FedRAMP)
. Get the details of a rebuild phones job by its job ID. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa. This API requires requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job status for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string - name: orgId in: query description: Check a rebuild phones job status in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/devices/rebuildPhones/{jobId}/errors: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorResponseObject' example: items: - itemNumber: 0 error: key: '500' message: - description: Unable to trigger device settings override process. code: null location: null trackingId: ROUTER_62F66055-8D70-01BB-0137-AC10A8310137 '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 Job Errors for a Rebuild Phones Job operationId: getJobErrorsForARebuildPhonesJob description: '
Not supported for Webex for Government (FedRAMP)
. Get errors for a rebuild phones job in an organization. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: jobId in: path description: Retrieve job errors for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU schema: type: string - name: orgId in: query description: Retrieve list of errors for a rebuild phones job in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/people/{personId}/devices/settings: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - compression properties: compression: $ref: '#/components/schemas/Compression' description: Toggles compression ON and OFF. example: compression: 'ON' '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 Device Settings for a Person operationId: getDeviceSettingsForAPerson description: 'Device settings list the compression settings for a person. Device settings customize a device''s behavior and performance. The compression field optimizes call quality for inbound and outbound calls. This API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: personId in: path description: ID of the person for whom to retrieve device settings. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI schema: type: string - name: orgId in: query description: Retrieves the device settings for a person in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE 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 Device Settings for a Person operationId: updateDeviceSettingsForAPerson description: 'Update device settings modifies the compression settings for a person. Device settings customize a device''s behavior and performance. The compression field optimizes call quality for inbound and outbound calls. This API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: personId in: path description: ID of the person for whom to update device settings. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI schema: type: string - name: orgId in: query description: Modify device settings for a person in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE schema: type: string requestBody: content: application/json: example: compression: 'ON' schema: type: object required: - compression properties: compression: $ref: '#/components/schemas/Compression' description: Toggles compression ON and OFF. /telephony/config/workspaces/{workspaceId}/devices/settings: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - compression properties: compression: $ref: '#/components/schemas/Compression' description: Toggles compression ON and OFF. example: compression: 'ON' '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 Device Settings for a Workspace operationId: getDeviceSettingsForAWorkspace description: 'Device settings list the compression settings for a workspace. Device settings customize a device''s behavior and performance. The compression field optimizes call quality for inbound and outbound calls. This API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: workspaceId in: path description: ID of the workspace for which to retrieve device settings. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0 schema: type: string - name: orgId in: query description: Retrieves the device settings for a workspace in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE 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 Device Settings for a Workspace operationId: updateDeviceSettingsForAWorkspace description: 'Update device settings modifies the compression settings for a workspace. Device settings customize a device''s behavior and performance. The compression field optimizes call quality for inbound and outbound calls. This API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: workspaceId in: path description: ID of the workspace for which to update device settings. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0 schema: type: string - name: orgId in: query description: Modify the device settings for a workspace in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE schema: type: string requestBody: content: application/json: example: compression: 'ON' schema: type: object required: - compression properties: compression: $ref: '#/components/schemas/Compression' description: Toggles compression ON and OFF. /telephony/config/devices/backgroundImages: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - backgroundImages properties: backgroundImages: type: array items: $ref: '#/components/schemas/listBackgroundImagesObject' description: Array of background images. count: type: string example: '2' description: The total number of images in the org. example: backgroundImages: - backgroundImageUrl: /dms/Cisco_Phone_Background/background001 fileName: CompanyLogoBlue - backgroundImageUrl: /dms/Cisco_Phone_Background/background002 fileName: CompanyLogoRed count: 2 '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 the List of Background Images operationId: readTheListOfBackgroundImages description: 'Gets the list of device background images for an organization. Webex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image. Retrieving this list requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Retrieves the list of images in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string delete: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/deleteImageResponseSuccessObject' description: Array of deleted images. count: type: string example: '2' description: The total number of images in the org after deletion. example: items: - fileName: CompanyLogoBlue result: status: 200 count: 2 '206': description: Partial Content headers: {} content: application/json: schema: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/deleteImageResponseObject' description: Array of deleted images. count: type: string example: '2' description: The total number of images in the org after deletion. example: items: - fileName: CompanyLogoBlue result: status: 200 - fileName: CompanyLogoRed result: status: 400 error: message: The image could not be deleted. errorCode: 4305 count: 2 '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 Device Background Images operationId: deleteDeviceBackgroundImages description: 'Delete the list of designated device background images for an organization. Maximum is 10 images per request. Deleting a device background image requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Device Call Settings parameters: - name: orgId in: query description: Deletes the list of images in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: backgroundImages: - fileName: CompanyLogoBlue forceDelete: true schema: type: object required: - backgroundImages properties: backgroundImages: type: array items: $ref: '#/components/schemas/deleteImageRequestObject' description: Array of images to be deleted. /telephony/config/devices/{deviceId}/actions/backgroundImageUpload/invoke: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object properties: filename: type: string example: CompanyLogoBlue description: The name of the uploaded image file. backgroundImageUrl: type: string example: '"/dms/Cisco_Phone_Background/background001"' description: The URL of the uploaded image file. count: type: string example: '2' description: The total number of images in the org after uploading. example: filename: CompanyLogoBlue backgroundImageUrl: '"/dms/Cisco_Phone_Background/background001"' count: '2' '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: Upload a Device Background Image operationId: uploadADeviceBackgroundImage description: 'Configure a device''s background image by uploading an image with file format, `.jpeg` or `.png`, encoded image file. Maximum image file size allowed to upload is 625 KB. The request must be a multipart/form-data request rather than JSON, using the image/jpeg or image/png content-type. Webex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image. Uploading a device background image requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.' tags: - Device Call Settings parameters: - name: deviceId in: path description: Unique identifier for the device. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE= schema: type: string - name: orgId in: query description: Uploads the image in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: required: true content: multipart/form-data: schema: type: object required: - file - fileName properties: file: type: string format: binary description: The image file to upload. Must be in `.jpeg` or `.png` format. Maximum file size is 625 KB. fileName: type: string description: The name of the image file being uploaded. example: CompanyLogoBlue.png /telephony/config/people/{personId}/devices/count: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/userDeviceCount' example: totalDeviceCount: 3 applicationsCount: 4 '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 User Devices Count operationId: getUserDevicesCount description: 'Get the total device and application count for a person. The device count can be used to determine if more devices can be added for users with a device count limit. For example, users with standard calling licenses can only have one physical device. This requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Device Call Settings parameters: - name: personId in: path description: Person for whom to retrieve the device count. required: true example: Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M schema: type: string - name: orgId in: query description: Organization to which the person belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string components: schemas: GetMemberResponse: type: object required: - model - maxLineCount properties: model: type: string example: DMS Cisco 192 description: Model type of the device. members: type: array items: $ref: '#/components/schemas/MemberObject' description: List of members that appear on the device. maxLineCount: type: number example: 10 description: Maximum number of lines available for the device. devices: type: object required: - id - model - primaryOwner - type - hoteling - owner - activationState properties: id: type: string description: Unique identifier for a device. description: type: array items: type: string description: Comma separated array of tags used to describe device. model: type: string description: Identifier for device model. modelType: $ref: '#/components/schemas/DeviceType' description: Identifier for device model type. mac: type: string description: MAC address of device. ipAddress: type: string description: IP address of device. primaryOwner: type: boolean description: Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device. type: $ref: '#/components/schemas/DeviceLineType' description: Indicates if the line is acting as a primary line or a shared line for this device. hoteling: $ref: '#/components/schemas/HotelingRequest' description: Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level. owner: $ref: '#/components/schemas/deviceOwner' description: Owner of device. activationState: $ref: '#/components/schemas/ActivationStates' description: Activation state of device. PutThirdPartyDevice: type: object required: - sipPassword properties: sipPassword: type: string example: Test4Password123& description: Password to be updated. DectDeviceList: type: object required: - model - displayName properties: model: type: string example: DMS Cisco DBS110 description: Model name of the device. displayName: type: string example: Cisco DECT 210 Base description: Display name of the device. numberOfBaseStations: type: number example: 250 description: Indicates number of base stations. numberOfLinePorts: type: number example: 1000 description: Indicates number of port lines, numberOfRegistrationsSupported: type: number example: 30 description: Indicates number of supported registrations. ApplyLineKeyTemplateJobErrors: type: object required: - trackingId properties: trackingId: type: string description: Unique identifier to track the HTTP requests. error: $ref: '#/components/schemas/ErrorMessageObject' description: Description of errors in the job. PhoneLanguage: type: string enum: - PERSON_LANGUAGE - ARABIC - BULGARIAN - CATALAN - CHINESE_SIMPLIFIED - CHINESE_TRADITIONAL - CROATIAN - CZECH - DANISH - DUTCH - ENGLISH_UNITED_STATES - ENGLISH_UNITED_KINGDOM - FINNISH - FRENCH_CANADA - FRENCH_FRANCE - GERMAN - GREEK - HEBREW - HUNGARIAN - ITALIAN - JAPANESE - KOREAN - NORWEGIAN - POLISH - PORTUGUESE_PORTUGAL - RUSSIAN - SPANISH_COLOMBIA - SPANISH_SPAIN - SLOVAK - SWEDISH - SLOVENIAN - TURKISH - UKRAINE description: ' * `PERSON_LANGUAGE` - Indicates a person''s announcement language. ' PostApplyLineKeyTemplateRequest: type: object required: - action - templateId properties: action: type: string enum: - APPLY_TEMPLATE - APPLY_DEFAULT_TEMPLATES description: "Line key Template action to perform.\n * `APPLY_TEMPLATE` - Used to apply LinekeyTemplate to devices.\n * `APPLY_DEFAULT_TEMPLATES` - Used to reset devices to its default Linekey Template configurations.\n" templateId: type: string example: Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM= description: '`templateId` is required for `APPLY_TEMPLATE` action.' locationIds: type: array items: type: string description: Used to search for devices only in the given locations. excludeDevicesWithCustomLayout: type: boolean description: Indicates whether to exclude devices with custom layout. includeDeviceTags: type: array items: type: string description: Include devices only with these tags. excludeDeviceTags: type: array items: type: string description: Exclude devices with these tags. advisoryTypes: $ref: '#/components/schemas/LineKeyTemplateAdvisoryTypes' description: Refine search with advisories. UsbPortsObject: type: object required: - enabled - sideUsbEnabled - rearUsbEnabled properties: enabled: type: boolean description: New Control to Enable/Disable the side USB port. sideUsbEnabled: type: boolean example: true description: Enable/disable use of the side USB port on the MPP device. Enabled by default. rearUsbEnabled: type: boolean example: true description: Enable/disable use of the rear USB port on the MPP device. AuthenticationMethodObject: type: string enum: - NONE - EAP_FAST - PEAP_GTC - PEAP_MSCHAPV2 - PSK - WEP description: " * `NONE` - No authentication.\n * `EAP_FAST` - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.\n * `PEAP_GTC` - Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.\n * `PEAP_MSCHAPV2` - Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.\n * `PSK` - Pre-Shared Key. Requires shared passphrase for authentication.\n * `WEP` - Wired Equivalent Privacy. Requires encryption key for authentication.\n" lineKeyTemplatesResponse: type: object required: - id - templateName - deviceModel - modelDisplayName properties: id: type: string example: Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM= description: Unique identifier for the Line Key Template. templateName: type: string example: template for 8845 description: Name of the Line Key Template. deviceModel: type: string example: DMS Cisco 8845 description: The Device Model for which the Line Key Template is applicable. modelDisplayName: type: string example: Cisco 8845 description: The friendly display name used to represent the device model in Control Hub. 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. VlanObjectDevice: type: object required: - enabled - value properties: enabled: type: boolean example: true description: Denotes whether the VLAN object of an ATA is enabled. value: type: number example: 1 description: The value of the VLAN Object of an ATA object. CustomizationObject: type: object properties: ata: $ref: '#/components/schemas/ataObject' description: Settings that are applicable to ATA devices. dect: $ref: '#/components/schemas/dectObject' description: Settings that are applicable to DECT devices. mpp: $ref: '#/components/schemas/mppObject' description: Settings that are applicable to MPP devices. wifi: $ref: '#/components/schemas/wifiObject' description: Settings that are applicable to WiFi. HotelingRequest: type: object required: - enabled properties: enabled: type: boolean description: 'Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device as if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone.' limitGuestUse: type: boolean description: Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`. guestHoursLimit: type: number description: Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled. AtaDtmfModeObject: type: string enum: - STRICT - NORMAL description: " * `STRICT` - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.\n * `NORMAL` - Normal threshold mode.\n" PutMemberObject: type: object required: - port - id - primaryOwner - lineType - lineWeight - hotlineEnabled - hotlineDestination - allowCallDeclineEnabled properties: port: type: number example: 1 description: Person's assigned port number. id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier for the member. t38FaxCompressionEnabled: type: boolean description: T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options. primaryOwner: type: boolean example: true description: Whether the user is the owner of the device or not, and points to a primary Line/Port of device. lineType: $ref: '#/components/schemas/LineType' description: Line type is used to differentiate Primary and SCA, at which endpoint it is assigned. lineWeight: type: number example: 1 description: Number of lines that have been configured for the person on the device. hotlineEnabled: type: boolean example: true description: Enable Hotline. 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: '+12055552222' description: The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true. allowCallDeclineEnabled: type: boolean example: true description: Set how a person's 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 only declines the current endpoint. lineLabel: type: string example: share line label description: Device line label. userDeviceCount: type: object required: - totalDeviceCount - applicationsCount properties: totalDeviceCount: type: number example: 3 description: 'The total count of devices associated with the user as a sum of: - Count of total primary physical devices. - Count of Webex-Team system device endpoints. - Count of 1 for any or all applications present.' applicationsCount: type: number example: 4 description: The total count of applications associated with the user. MppVlanObjectDevice: type: object required: - enabled properties: enabled: type: boolean description: Indicates whether the VLAN object of an MPP is enabled. value: type: number example: 1 description: Indicates the value of a VLAN object for an MPP object. pcPort: type: number example: 1 description: Indicates the PC port value of a VLAN object for an MPP object. CallHistoryMethod: type: string enum: - WEBEX_UNIFIED_CALL_HISTORY - LOCAL_CALL_HISTORY description: " * `WEBEX_UNIFIED_CALL_HISTORY` - Set call history to use the unified call history from all of the end user's devices.\n * `LOCAL_CALL_HISTORY` - Set call history to use local device information only.\n" DeviceSettingsObjectForDeviceLevel: type: object required: - customizations - customEnabled - updateInProgress - deviceCount - lastUpdateTime properties: customizations: $ref: '#/components/schemas/CustomizationDeviceLevelObjectDevice' description: Indicates the customization object of the device settings. customEnabled: type: boolean example: true description: Indicates if customization is allowed at a device level. If `true`, customized at a device level. If `false`, not customized; uses customer-level configuration. updateInProgress: type: boolean example: true description: Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed). deviceCount: type: number example: 9 description: Number of devices that will be updated. lastUpdateTime: type: number example: 1659624763665 description: Indicates the last updated time. WifiNetworkObject: type: object required: - enabled - authenticationMethod - ssidName - userId properties: enabled: type: boolean description: Indicates whether the wifi network is enabled. authenticationMethod: $ref: '#/components/schemas/AuthenticationMethodObject' description: Authentication method of wifi network. ssidName: type: string example: my_wifi_network description: SSID name of the wifi network. userId: type: string example: test-user description: User Id of the wifi network. HttpProxyObject: type: object required: - mode - autoDiscoveryEnabled - host - port - packUrl - authSettingsEnabled - username - password properties: mode: type: string enum: - 'OFF' - AUTO - MANUAL description: Mode of the HTTP proxy. autoDiscoveryEnabled: type: boolean example: true description: Enable/disable auto discovery of the URL. host: type: string example: www.example.wxc description: Specify the host URL if the HTTP mode is set to `MANUAL`. port: type: string example: '3128' description: Specify the port if the HTTP mode is set to `MANUAL`. packUrl: type: string example: www.example.wxc description: Specify PAC URL if auto discovery is disabled. authSettingsEnabled: type: boolean example: true description: Enable/disable authentication settings. username: type: string example: john description: Specify a username if authentication settings are enabled. password: type: string example: private description: Specify a password if authentication settings are enabled. DectVlanObject: type: object required: - enabled - value properties: enabled: type: boolean description: Denotes whether the VLAN object of DECT is enabled. value: type: number description: Value of the VLAN Object of DECT. AtaDtmfMethodObject: type: string enum: - INBAND - AVT - AUTO description: " * `INBAND` - Sends DTMF by using the audio path.\n * `AVT` - Audio video transport. Sends DTMF as AVT events.\n * `AUTO` - Uses InBand or AVT based on the outcome of codec negotiation.\n" MacStatusObject: type: object required: - mac - state properties: mac: type: string example: 00005E0053B4 description: MAC address. state: type: string enum: - AVAILABLE - UNAVAILABLE - DUPLICATE_IN_LIST - INVALID description: "State of the MAC address.\n * `AVAILABLE` - The requested MAC address is available.\n * `UNAVAILABLE` - The requested MAC address is unavailable.\n * `DUPLICATE_IN_LIST` - The requested MAC address is duplicated.\n * `INVALID` - The requested MAC address is invalid.\n" errorCode: type: number example: 5675 description: MAC address validation error code. message: type: string example: '[Error 5675] MAC Address is in use.' description: Provides a status message about the MAC address. BacklightTimer68XX: type: string enum: - ALWAYS_ON - TEN_SEC - TWENTY_SEC - THIRTY_SEC - 'OFF' description: " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n" SoftKeyMenuObject: type: object required: - idleKeyList - offHookKeyList - dialingInputKeyList - progressingKeyList - connectedKeyList - connectedVideoKeyList - startTransferKeyList - startConferenceKeyList - conferencingKeyList - releasingKeyList - holdKeyList - ringingKeyList - sharedActiveKeyList - sharedHeldKeyList properties: idleKeyList: type: string example: guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages description: Specify the idle key list. offHookKeyList: type: string example: endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7 description: Specify the off hook key list. dialingInputKeyList: type: string example: dial|1;cancel|2;delchar|3;left|5;right|6 description: Specify the dialing input key list. progressingKeyList: type: string example: endcall|2 description: Specify the progressing key list. connectedKeyList: type: string example: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume description: Specify the connected key list. connectedVideoKeyList: type: string example: hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume description: Specify the connected video key list. startTransferKeyList: type: string example: endcall|2;xfer|3 description: Start the transfer key list. startConferenceKeyList: type: string example: endcall|2;conf|3 description: Start the conference key list. conferencingKeyList: type: string example: endcall;join;crdstart;crdstop;crdpause;crdresume description: Specify the conferencing key list. releasingKeyList: type: string example: endcall|2 description: Specify the releasing key list. holdKeyList: type: string example: resume|1;endcall|2;newcall|3;redial|4;dir|5 description: Specify the hold key list. ringingKeyList: type: string example: answer|1;ignore|2 description: Specify the ringing key list. sharedActiveKeyList: type: string example: newcall|1;psk1|2;dir|3;back|4 description: Specify the shared active key list. sharedHeldKeyList: type: string example: resume|1;dir|4 description: Specify the shared held key list. PoeMode: type: string enum: - NORMAL - MAXIMUM description: " * `NORMAL` - Use normal power consumption.\n * `MAXIMUM` - Use maximum power consumption.\n" WifiAudioCodecPriorityObjectDevice: type: object required: - selection - primary - secondary - tertiary properties: selection: type: string example: CUSTOM description: Indicates the selection of the Audio Codec Priority Object for an WiFi object. primary: type: string example: OPUS description: Indicates the primary Audio Codec for an WiFi object. secondary: type: string example: G722 description: Indicates the secondary Audio Codec for an WiFi object. tertiary: type: string example: G711u description: Indicates the tertiary Audio Codec for an WiFi object. RebuildPhonesList: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/RebuildPhonesJob' description: List of rebuild phones jobs. DirectoryMethod: type: string enum: - XSI_DIRECTORY - WEBEX_DIRECTORY description: " * `XSI_DIRECTORY` - Set directory services to use standard XSI query method from the device.\n * `WEBEX_DIRECTORY` - Set directory services to use the Webex Enterprise directory.\n" MppVlanObject: type: object required: - enabled properties: enabled: type: boolean description: Indicates whether the VLAN object of an MPP is enabled. value: type: number example: 1 description: Indicates the value of a VLAN object for an MPP object. pcPort: type: number example: 1 description: Indicates the PC port value of a VLAN object for an MPP object. AcdObjectDevice: type: object required: - enabled - displayCallqueueAgentSoftkeys properties: enabled: type: boolean example: true description: Indicates whether the ACD object is enabled. displayCallqueueAgentSoftkeys: $ref: '#/components/schemas/DisplayCallqueueAgentSoftkeysObject' description: Indicates the call queue agent soft key value of an ACD object. LineKeyTemplateAdvisoryTypes: type: object properties: moreSharedAppearancesEnabled: type: boolean example: true description: Refine search to apply changes to devices that contain the warning "More shared/virtual line appearances than shared/virtual lines requested". fewSharedAppearancesEnabled: type: boolean example: true description: Refine search to apply changes to devices that contain the warning "More shared/virtual lines requested than shared/virtual line appearances". moreMonitorAppearancesEnabled: type: boolean example: true description: Refine search to apply changes to devices that contain the warning "More monitored line appearances than monitored lines in the user's monitoring list". moreCPEAppearancesEnabled: type: boolean example: true description: Refine search to apply changes to devices that contain the warning "More call park extension line appearances than call park extensions in user's monitoring list". moreModeManagementAppearancesEnabled: type: boolean example: true description: Refine search to apply changes to devices that contain the warning "More mode management lines configured for the device". The default value is false. listBackgroundImagesObject: type: object required: - backgroundImageUrl - fileName properties: backgroundImageUrl: type: string example: '"/dms/Cisco_Phone_Background/background001"' description: The URL of the image file. fileName: type: string example: CompanyLogoBlue description: The name of the image file. DeviceType: type: string enum: - DEVICE - APPLICATION description: " * `DEVICE` - The endpoint is a device.\n * `APPLICATION` - The endpoint is a application.\n" KEMKeys: type: object required: - kemModuleIndex - kemKeyIndex - kemKeyType - sharedLineIndex properties: kemModuleIndex: type: number example: 1 description: An index representing a KEM Module. The Index starts from 1 representing the first KEM Module. kemKeyIndex: type: number example: 1 description: An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone. kemKeyType: $ref: '#/components/schemas/LineKeyType' description: The action that would be performed when the KEM Key is pressed. kemKeyLabel: type: string example: Office description: Applicable only when the kemKeyType is `SPEED_DIAL`. kemKeyValue: type: string example: '213457' description: 'Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`).' sharedLineIndex: type: number example: 4 description: Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line. CommSecurityType: type: string enum: - NONE - SSL - STARTTLS description: " * `NONE` - Sets the LDAP server security protocol to None.\n * `SSL` - Sets the LDAP server security protocol to SSL.\n * `STARTTLS` - Sets the LDAP server security protocol to STARTTLS.\n" ErrorResponseObject: type: object properties: items: type: array items: $ref: '#/components/schemas/ItemObject' BluetoothObjectDevice: type: object required: - enabled properties: enabled: type: boolean example: true description: Enable/disable Bluetooth. mode: type: string enum: - PHONE - HANDS_FREE - BOTH description: Select a Bluetooth mode. DeviceLayout: type: object required: - layoutMode - lineKeys properties: layoutMode: $ref: '#/components/schemas/LayoutMode' description: Defines the layout mode of the device, i.e. DEFAULT or CUSTOM. userReorderEnabled: type: boolean example: true description: If `true`, user customization is enabled. lineKeys: type: array items: $ref: '#/components/schemas/ProgrammableLineKeys' description: Contains a mapping of Line Keys and their corresponding actions. kemModuleType: $ref: '#/components/schemas/KemModuleType' description: Type of KEM module. kemKeys: type: array items: $ref: '#/components/schemas/KEMKeys' description: Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN. RebuildPhonesPostRequest: type: object required: - locationId properties: locationId: type: string description: Unique identifier of the location. BackgroundImageColor: type: string enum: - CYAN_DARK - PURPLE_DARK - BLUE_DARK - VIOLET_DARK - BLUE_LIGHT - VIOLET_LIGHT description: " * `CYAN_DARK` - Indicates that dark cyan background image will be set for the devices.\n * `PURPLE_DARK` - Indicates the dark purple background image will be set for the devices.\n * `BLUE_DARK` - Indicates the dark blue background image will be set for the devices.\n * `VIOLET_DARK` - Indicates the dark violet background image will be set for the devices.\n * `BLUE_LIGHT` - Indicates the light blue background image will be set for the devices.\n * `VIOLET_LIGHT` - Indicates the light violet background image will be set for the devices.\n" ScreenTimeoutObject: type: object required: - enabled - value properties: enabled: type: boolean example: true description: Indicates whether the Screen Time object is enabled. value: type: number example: 400 description: Indicates the value of screen timeout. ListDeviceSettingsObject: type: object required: - customizations - updateInProgress - deviceCount - lastUpdateTime properties: customizations: $ref: '#/components/schemas/CustomizationObject' description: Customization object of the device settings. updateInProgress: type: boolean description: Progress of the device update. deviceCount: type: number example: 22 description: Device count. lastUpdateTime: type: number example: 1659624763665 description: Last updated time. MppAudioCodecPriorityObjectDevice: type: object required: - selection - primary - secondary - tertiary properties: selection: $ref: '#/components/schemas/SelectionType' description: Indicates the selection of the Audio Codec Priority Object for an MPP object. primary: type: string example: OPUS description: Indicates the primary Audio Codec for an MPP object. secondary: type: string example: G722 description: Indicates the secondary Audio Codec for an MPP object. tertiary: type: string example: G711u description: Indicates the tertiary Audio Codec for an MPP object. deviceOwner: type: object required: - id - type - firstName - lastName properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw description: Unique identifier of a person or a workspace. type: $ref: '#/components/schemas/MemberType' description: Enumeration that indicates if the member is of type `PEOPLE` or `PLACE`. firstName: type: string example: Christian description: First name of device owner. lastName: type: string example: Smith description: Last name of device owner. MemberType: type: string enum: - PEOPLE - PLACE description: " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n" ApplyLineKeyTemplateJobDetails: type: object required: - name - id - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - percentageComplete - updatedCount - advisoryCount properties: name: type: string description: Job name. id: type: string description: Unique identifier of the job. trackingId: type: string description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string description: Unique identifier to identify the customer for which the job was run. instanceId: type: number 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 description: Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation. latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS 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" percentageComplete: type: integer description: Indicates the progress of the job. updatedCount: type: integer description: Number of job steps completed. advisoryCount: type: integer description: Number of job steps completed with advisories. PostLineKeyTemplateRequest: type: object required: - templateName - deviceModel - lineKeys properties: templateName: type: string example: template for 8845 description: Name of the Line Key Template. deviceModel: type: string example: DMS Cisco 8845 description: The model of the device for which the Line Key Template is applicable. The corresponding device model display name sometimes called the product name, can also be used to specify the model. userReorderEnabled: type: boolean example: true description: User Customization Enabled. lineKeys: type: array items: $ref: '#/components/schemas/ProgrammableLineKeys' description: Contains a mapping of Line Keys and their corresponding actions. LayoutMode: type: string enum: - DEFAULT - CUSTOM description: " * `DEFAULT` - Default layout mode when a new device is added.\n * `CUSTOM` - Enables a device to have its custom layout.\n" ListDectDeviceType: type: object required: - devices properties: devices: type: array items: $ref: '#/components/schemas/DectDeviceList' description: Contains a list of devices. CallForwardExpandedSoftKey: type: string enum: - ONLY_THE_CALL_FORWARD_ALL - ALL_CALL_FORWARDS description: " * `ONLY_THE_CALL_FORWARD_ALL` - Set the default call forward expanded soft key behavior to single option.\n * `ALL_CALL_FORWARDS` - Set the default call forward expanded soft key behavior to multiple menu option.\n" ActivationStates: type: string enum: - activating - activated - deactivated description: " * `activating` - Device is activating using an activation code.\n * `activated` - Device has been activated using an activation code.\n * `deactivated` - Device has not been activated using an activation code.\n" MppAudioCodecPriorityObject: type: object required: - selection - primary - secondary - tertiary properties: selection: type: string example: CUSTOM description: Indicates the selection of the Audio Codec Priority Object for an MPP object. primary: type: string example: OPUS description: Indicates the primary Audio Codec for an MPP object. secondary: type: string example: G722 description: Indicates the secondary Audio Codec for an MPP object. tertiary: type: string example: G711u description: Indicates the tertiary Audio Codec for an MPP object. RebuildPhonesJob: type: object required: - name - id - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - target - percentageComplete properties: name: type: string example: rebuildphones description: Name of the job which in this case, is `rebuildphones`. id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY description: Unique identifier of the job. trackingId: type: string example: ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ description: Unique identifier of the user who has run the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE description: Unique identifier of the customer who has run the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE description: Unique identifier of the customer for which the job was run. instanceId: type: number example: 428989 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: $ref: '#/components/schemas/LatestExecutionStatus' description: Indicates the most recent status of the job at the time of invocation. latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS 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" target: type: string example: LOCATION description: Indicates the target entity, i.e. LOCATION. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw description: Unique identifier of a location. percentageComplete: type: integer example: 10 description: Indicates the progress of the job. deviceCount: type: number example: 10 description: Count of number of devices rebuilt. DisplayCallqueueAgentSoftkeysObject: type: string enum: - FRONT_PAGE - LAST_PAGE KemModuleType: type: string enum: - KEM_14_KEYS - KEM_18_KEYS - KEM_20_KEYS description: " * `KEM_14_KEYS` - Extension module has 14 line keys that can be configured.\n * `KEM_18_KEYS` - Extension module has 18 line keys that can be configured.\n * `KEM_20_KEYS` - Extension module has 20 line keys that can be configured.\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. VolumeSettingsObject: type: object required: - ringerVolume - speakerVolume - handsetVolume - headsetVolume - eHookEnabled - allowEndUserOverrideEnabled properties: ringerVolume: type: number example: 9 description: Specify a ringer volume level through a numeric value between 0 and 15. speakerVolume: type: number example: 11 description: Specify a speaker volume level through a numeric value between 0 and 15. handsetVolume: type: number example: 10 description: Specify a handset volume level through a numeric value between 0 and 15. headsetVolume: type: number example: 10 description: Specify a headset volume level through a numeric value between 0 and 15. eHookEnabled: type: boolean example: true description: Enable/disable the wireless headset hookswitch control. allowEndUserOverrideEnabled: type: boolean example: true description: Enable/disable to preserve the existing values on the phone and not the values defined for the device settings. PutLineKeyTemplateRequest: type: object required: - lineKeys properties: userReorderEnabled: type: boolean example: true description: Indicates whether the user can reorder the line keys. lineKeys: type: array items: $ref: '#/components/schemas/ProgrammableLineKeys' description: List of line keys that are being updated. UserHotelingRequestPatch: type: object required: - hoteling properties: hoteling: $ref: '#/components/schemas/HotelingRequest' description: Modify person Device Hoteling Setting. SelectionType: type: string enum: - REGIONAL - CUSTOM description: " * `REGIONAL` - Indicates the regional selection type for audio codec priority.\n * `CUSTOM` - Indicates the custom selection type for audio codec priority.\n" 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. ataObjectDevice: type: object required: - audioCodecPriority - ataDtmfMode - ataDtmfMethod - cdpEnabled - lldpEnabled - qosEnabled - vlan - webAccessEnabled - nightlyResyncEnabled - snmp properties: audioCodecPriority: $ref: '#/components/schemas/AudioCodecPriorityObjectDevice' description: Choose up to three predefined codec priority options available for your region. ataDtmfMode: $ref: '#/components/schemas/AtaDtmfModeObject' description: DTMF Detection Tx Mode selection for Cisco ATA devices. ataDtmfMethod: $ref: '#/components/schemas/AtaDtmfMethodObject' description: Method for transmitting DTMF signals to the far end. cdpEnabled: type: boolean example: true description: Enable/disable Cisco Discovery Protocol for local devices. lldpEnabled: type: boolean example: true description: Enable/disable Link Layer Discovery Protocol for local devices. qosEnabled: type: boolean example: true description: Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform. vlan: $ref: '#/components/schemas/VlanObjectDevice' description: Specify a numeric Virtual LAN ID for devices. webAccessEnabled: type: boolean example: true description: Enable/disable user level web access to the local device. nightlyResyncEnabled: type: boolean example: true description: Enable/disable the automatic nightly configuration resync of the MPP device. snmp: $ref: '#/components/schemas/SnmpObject' description: Specify values needed to enable use of the SNMP service from the phone. 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. ataObject: type: object required: - audioCodecPriority - ataDtmfMode - ataDtmfMethod - cdpEnabled - lldpEnabled - qosEnabled - vlan - webAccessEnabled - nightlyResyncEnabled - snmp properties: audioCodecPriority: $ref: '#/components/schemas/AudioCodecPriorityObject' description: Choose up to three predefined codec priority options available for your region. ataDtmfMode: $ref: '#/components/schemas/AtaDtmfModeObject' description: DTMF Detection Tx Mode selection for Cisco ATA devices. ataDtmfMethod: $ref: '#/components/schemas/AtaDtmfMethodObject' description: Method for transmitting DTMF signals to the far end. cdpEnabled: type: boolean example: true description: Enable/disable Cisco Discovery Protocol for local devices. lldpEnabled: type: boolean example: true description: Enable/disable Link Layer Discovery Protocol for local devices. qosEnabled: type: boolean example: true description: Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform. vlan: $ref: '#/components/schemas/VlanObject' description: Specify a numeric Virtual LAN ID for devices. webAccessEnabled: type: boolean example: true description: Enable/disable user level web access to the local device. nightlyResyncEnabled: type: boolean example: true description: Enable/disable the automatic nightly configuration resync of the MPP device. snmp: $ref: '#/components/schemas/SnmpObject' description: Specify values needed to enable use of the SNMP service from the phone. SoftKeyLayoutObject: type: object required: - softKeyMenu - psk - softKeyMenuDefaults - pskDefaults properties: softKeyMenu: $ref: '#/components/schemas/SoftKeyMenuObject' description: Customize SoftKey menu settings. psk: $ref: '#/components/schemas/PskObject' description: Customize PSK. softKeyMenuDefaults: $ref: '#/components/schemas/SoftKeyMenuObject' description: Default SoftKey menu settings. pskDefaults: $ref: '#/components/schemas/PskObject' description: Default PSK. SearchMemberResponse: type: object properties: members: type: array items: $ref: '#/components/schemas/SearchMemberObject' description: List of members available for the device. GetLineKeyTemplateResponse: type: object required: - id - templateName - deviceModel - modelDisplayName - userReorderEnabled - lineKeys properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ description: Unique identifier for the Line Key Template. templateName: type: string example: Basic Template description: Name of the Line Key Template. deviceModel: type: string example: '''DMS Cisco 6821''' description: The Device Model for which the Line Key Template is applicable. modelDisplayName: type: string example: Cisco 6821 description: The friendly display name used to represent the device model in Control Hub. userReorderEnabled: type: boolean description: Indicates whether user can reorder the line keys. lineKeys: type: array items: $ref: '#/components/schemas/ProgrammableLineKeys' description: Contains a mapping of Line Keys and their corresponding actions. DectAudioCodecPriorityObject: type: object required: - selection - primary - secondary - tertiary properties: selection: $ref: '#/components/schemas/SelectionType' description: Indicates the selection of an Audio Codec Priority Object. primary: type: string example: G729 description: Indicates the primary Audio Codec. secondary: type: string example: G711u description: Indicates the secondary Audio Codec. tertiary: type: string example: G711a description: Indicates the tertiary Audio Codec. placeDeviceList: type: object required: - devices - maxDeviceCount - maxOwnedDeviceCount properties: devices: type: array items: $ref: '#/components/schemas/placeDevices' description: Array of devices associated with a workspace. maxDeviceCount: type: number description: Maximum number of devices a workspace can be assigned to. maxOwnedDeviceCount: type: number description: Maximum number of devices a workspace can own. DeviceActivationStates: type: string enum: - ACTIVATING - ACTIVATED - DEACTIVATED description: " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n" ValidateMACRequest: type: object required: - macs properties: macs: type: array items: type: string example: ab125678cdef,00005E0053B4 description: MAC addresses to be validated. CustomizationDeviceLevelObjectDevice: type: object properties: ata: $ref: '#/components/schemas/ataObjectDevice' description: Applicable device settings for an ATA device. mpp: $ref: '#/components/schemas/mppObjectDevice' description: Applicable device settings for an MPP device. wifi: $ref: '#/components/schemas/wifiObjectDevice' description: Applicable device settings for a WiFi device. PutMembersRequest: type: object properties: members: type: array items: $ref: '#/components/schemas/PutMemberObject' description: This specifies the new list of device members, completely replacing the existing device members. If the member's list is omitted then all the users are removed except the primary user. Compression: type: string enum: - 'ON' - 'OFF' description: " * `ON` - Minimize data use during compression.\n * `OFF` - Ignore data use during compression.\n" BacklightTimerObject: type: string enum: - ONE_MIN - FIVE_MIN - THIRTY_MIN - ALWAYS_ON description: " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n" DeviceSettingsObject: type: object required: - customizations - customEnabled - updateInProgress - deviceCount - lastUpdateTime properties: customizations: $ref: '#/components/schemas/CustomizationDeviceLevelObject' description: Indicates the customization object of the device settings. customEnabled: type: boolean example: true description: Indicates if customization is allowed at a location level. If `true`, customized at a location level. If `false`, not customized; uses customer-level configuration. updateInProgress: type: boolean example: true description: Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed). deviceCount: type: number example: 9 description: Number of devices that will be updated. lastUpdateTime: type: number example: 1659624763665 description: Indicates the last updated time. 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. WebAccessObject: type: object required: - enabled - password properties: enabled: type: boolean description: Ability to enable or disable the web browser access for the 840/860. password: type: string example: password description: Ability to set a Web Server Password. ApplyLineKeyTemplateJobList: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ApplyLineKeyTemplateJobDetails' description: List of Apply Line Key Template jobs. PskObject: type: object required: - psk1 - psk4 properties: psk1: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK1. psk2: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK2. psk3: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK3. psk4: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK4. psk5: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK5. psk6: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK6. psk7: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK7. psk8: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK8. psk9: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK9. psk10: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK10. psk11: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK11. psk12: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK12. psk13: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK13. psk14: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK14. psk15: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK15. psk16: type: string example: fnc=sd;ext=*11;nme=Call Pull description: Specify PSK16. dectObject: type: object required: - audioCodecPriority - cdpEnabled - dect6825HandsetEmergencyNumber - lldpEnabled - multicast - qosEnabled - vlan - webAccessEnabled - nightlyResyncEnabled properties: audioCodecPriority: $ref: '#/components/schemas/DectAudioCodecPriorityObject' description: Choose up to three predefined codec priority options available for your region. cdpEnabled: type: boolean example: true description: Enable/disable Cisco Discovery Protocol for local devices. dect6825HandsetEmergencyNumber: type: string description: Specify the destination number to be dialled from the DECT Handset top button when pressed. lldpEnabled: type: boolean example: true description: Enable/disable Link Layer Discovery Protocol for local devices. multicast: type: string description: Specify up to 3 multicast group URLs each with a unique listening port. qosEnabled: type: boolean example: true description: Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform. vlan: $ref: '#/components/schemas/DectVlanObject' description: Specify a numeric Virtual LAN ID for devices. webAccessEnabled: type: boolean example: true description: Enable/disable user level web access to the local device. nightlyResyncEnabled: type: boolean example: true description: Enable/disable phone's default behavior regarding the nightly maintenance synchronization with the Webex Calling platform. NoiseCancellationObject: type: object required: - enabled - allowEndUserOverrideEnabled properties: enabled: type: boolean example: true description: Enable/disable the Noise Cancellation. allowEndUserOverrideEnabled: type: boolean example: true description: Enable/disable to preserve the existing values on the phone and not the value defined for the device setting. WifiNetworkObjectDevice: type: object required: - enabled - authenticationMethod - ssidName - userId properties: enabled: type: boolean description: Indicates whether the wifi network is enabled. authenticationMethod: $ref: '#/components/schemas/AuthenticationMethodObject' description: Authentication method of the WiFi network. ssidName: type: string example: my_wifi_network description: SSID name of the wifi network. userId: type: string example: test-user description: User ID for the WiFi network. BacklightTimerObjectDevice: type: string enum: - ONE_MIN - FIVE_MIN - THIRTY_MIN - ALWAYS_ON description: " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n" LdapObject: type: object required: - enabled - serverAddress - serverPort - commSecurityType - bindDn - bindPw - baseDn - primaryEmailAttribute - alternateEmailAttribute properties: enabled: type: boolean description: Sets the values needed to enable use of the LDAP service on the phone. serverAddress: type: string example: localhost description: Sets the values needed to enable use of the LDAP service on the phone. serverPort: type: number example: 8080 description: Sets the values needed to enable use of the LDAP service on the phone. commSecurityType: $ref: '#/components/schemas/CommSecurityType' description: Indicates the selection of the protocol for LDAP service on the phone. bindDn: type: string example: bindDn description: Sets the values needed to enable use of the LDAP service on the phone. bindPw: type: string example: bindPw description: Sets the values needed to enable use of the LDAP service on the phone. baseDn: type: string example: baseDn description: Sets the values needed to enable use of the LDAP service on the phone. primaryEmailAttribute: type: string example: primaryEmailAttribute description: Sets the values needed to enable use of the LDAP service on the phone. alternateEmailAttribute: type: string example: alternateEmailAttribute description: Sets the values needed to enable use of the LDAP service on the phone. SearchMemberObject: type: object required: - id - firstName - lastName - lineType - allowCallDeclineEnabled - memberType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier for the member. firstName: type: string example: John description: First name of a person or workspace. lastName: type: string example: Smith description: Last name of a person or workspace. phoneNumber: type: string example: '+12055552221' description: Phone Number of a person or workspace. t38FaxCompressionEnabled: type: boolean description: T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options. lineType: $ref: '#/components/schemas/LineType' description: Line type is used to differentiate Primary and SCA, at which endpoint it is assigned. allowCallDeclineEnabled: type: boolean example: true description: Set how a person's 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 only declines the current endpoint. memberType: $ref: '#/components/schemas/MemberType' description: Indicates if 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. jobIdResponseObject: type: object required: - name - id - jobType - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - operationType - sourceLocationId - targetLocationId - counts properties: name: type: string example: managenumbers description: Job name. id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU description: Unique identifier of the job. jobType: type: string example: managenumbers description: Job type. trackingId: type: string example: ATLAS_06a92f81-244d-4fd2-b8db-121bc1eeb6c8_11 description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM description: Unique identifier to identify the customer for which the job was run. instanceId: type: number example: 238972 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" operationType: type: string example: MOVE description: The operation type that was carried out. sourceLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E2MmRlOWRkLWRmODEtNDg3My04MGY5LTY2MmYyZmM3ZTI2NQ description: Unique location identifier for which the job was run. targetLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw description: Unique location identifier for which the numbers have been moved. counts: $ref: '#/components/schemas/CountObject' description: Job statistics. DefaultLoggingLevelObject: type: string enum: - STANDARD - DEBUGGING description: " * `STANDARD` - Enables standard logging.\n * `DEBUGGING` - Enables detailed debugging logging.\n" deleteImageResponseObject: type: object required: - fileName - result properties: fileName: type: string example: CompanyLogoBlue description: The name of the image file. result: type: object required: - status properties: status: type: number example: 400 description: The status of the deletion. error: type: object required: - message - errorCode properties: message: type: string example: The image could not be deleted. description: The error message. errorCode: type: number example: 4305 description: The error code. description: The error message if the deletion failed. description: The result of the deletion. MACAddressResponse: type: object required: - status - macStatus properties: status: type: string enum: - OK - ERRORS description: Status of MAC address. macStatus: type: array items: $ref: '#/components/schemas/MacStatusObject' description: Contains an array of all the MAC address provided and their statuses. 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. VlanObject: type: object required: - enabled - value properties: enabled: type: boolean example: true description: Denotes whether the VLAN object of an ATA is enabled. value: type: number example: 1 description: The value of the VLAN Object of an ATA object. wifiObjectDevice: type: object required: - audioCodecPriority - ldap - webAccess - phoneSecurityPwd properties: audioCodecPriority: $ref: '#/components/schemas/WifiAudioCodecPriorityObjectDevice' description: Choose up to three predefined codec priority options available for your region. ldap: $ref: '#/components/schemas/LdapObjectDevice' description: Set the values needed to enable use of the LDAP service on the phone. webAccess: $ref: '#/components/schemas/WebAccessObject' description: Set the availability of the local end user web access for an 840/860 WiFi phone. phoneSecurityPwd: type: string example: phoneSecurityPwd description: Set the local security password on an 840/860 WiFi phone. mppObject: type: object required: - pnacEnabled - audioCodecPriority - backlightTimer - background - cdpEnabled - defaultLoggingLevel - dndServicesEnabled - acd - shortInterdigitTimer - longInterdigitTimer - lineKeyLabelFormat - lineKeyLEDPattern - lldpEnabled - mppUserWebAccessEnabled - multicast - enhancedMulticast - offHookTimer - phoneLanguage - poeMode - qosEnabled - screenTimeout - usbPortsEnabled - vlan - wifiNetwork - callHistory - contacts - webexMeetingsEnabled - volumeSettings - cfExpandedSoftKey - httpProxy - bluetooth - passThroughPortEnabled - userPasswordOverrideEnabled - activeCallFocusEnabled - peerFirmwareEnabled - noiseCancellation - voiceFeedbackAccessibilityEnabled - dialAssistEnabled - callsPerLine - nightlyResyncEnabled - missedCallNotificationEnabled - softKeyLayout - backgroundImage8875 - backlightTimer68XX78XX - allowMonitorLinesEnabled properties: pnacEnabled: type: boolean example: true description: Indicates whether the PNAC of MPP object is enabled or not. audioCodecPriority: $ref: '#/components/schemas/MppAudioCodecPriorityObject' description: Choose up to three predefined codec priority options available for your region. backlightTimer: $ref: '#/components/schemas/BacklightTimerObject' description: Choose the length of time (in minutes) for the phone's backlight to remain on. background: type: object properties: image: $ref: '#/components/schemas/BackgroundImage' customUrl: type: string displayNameFormat: $ref: '#/components/schemas/DisplayNameSelection' description: The display name that appears on the phone screen. cdpEnabled: type: boolean description: Allows you to enable/disable CDP for local devices. defaultLoggingLevel: $ref: '#/components/schemas/DefaultLoggingLevelObject' description: Choose the desired logging level for an MPP devices. dndServicesEnabled: type: boolean example: true description: Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones. acd: $ref: '#/components/schemas/AcdObject' description: Holds the Acd object value. shortInterdigitTimer: type: number example: 14 description: Indicates the short inter digit timer value. longInterdigitTimer: type: number example: 16 description: Indicates the long inter digit timer value.. lineKeyLabelFormat: $ref: '#/components/schemas/LineKeyLabelSelection' description: Line key labels define the format of what's shown next to line keys. lineKeyLEDPattern: $ref: '#/components/schemas/LineKeyLEDPattern' description: LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875 lldpEnabled: type: boolean description: Enable/disable Link Layer Discovery Protocol for local devices. mppUserWebAccessEnabled: type: boolean example: true description: Enable/disable user-level access to the web interface of Multi-Platform Phones. multicast: type: array items: type: string example: '["192.86.108.226:22"]' description: Select up to 10 Multicast Group URLs (each with a unique Listening Port). enhancedMulticast: $ref: '#/components/schemas/EnhancedMulticastObject' description: Specify the enhanced multicast settings for the MPP device. offHookTimer: type: number example: 30 description: Specify the amount of time (in seconds) that a phone can remain off-hook. phoneLanguage: $ref: '#/components/schemas/PhoneLanguage' description: Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location. poeMode: $ref: '#/components/schemas/PoeMode' description: Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones. qosEnabled: type: boolean example: true description: Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform. screenTimeout: $ref: '#/components/schemas/ScreenTimeoutObject' description: Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates. usbPortsEnabled: type: boolean example: true description: Enable/disable the use of the USB ports on Multi-Platform phones. vlan: $ref: '#/components/schemas/MppVlanObject' description: Specify a numeric Virtual LAN ID for devices. wifiNetwork: $ref: '#/components/schemas/WifiNetworkObject' description: Specify the Wi-Fi SSID and password for wireless-enabled MPP phones. callHistory: $ref: '#/components/schemas/CallHistoryMethod' description: Specify the call history information to use. Only applies to user devices. contacts: $ref: '#/components/schemas/DirectoryMethod' description: Specify the directory services to use. webexMeetingsEnabled: type: boolean example: true description: Enable/disable the availability of the webex meetings functionality from the phone. volumeSettings: $ref: '#/components/schemas/VolumeSettingsObject' description: Specify all volume level values on the phone. cfExpandedSoftKey: $ref: '#/components/schemas/CallForwardExpandedSoftKey' description: Specify the call forward expanded soft key behavior. httpProxy: $ref: '#/components/schemas/HttpProxyObject' description: Specify HTTP Proxy values. bluetooth: $ref: '#/components/schemas/BluetoothObject' description: Enable/disable the visibility of the bluetooth menu on the MPP device. passThroughPortEnabled: type: boolean example: true description: Enable/disable the use of the PC passthrough ethernet port on supported phone models. userPasswordOverrideEnabled: type: boolean example: true description: Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device. activeCallFocusEnabled: type: boolean example: true description: Enable/disable the default screen behavior when inbound calls are received. peerFirmwareEnabled: type: boolean example: true description: Enable/disable peer firmware sharing. noiseCancellation: $ref: '#/components/schemas/NoiseCancellationObject' description: Enable/disable local noise cancellation on active calls from the device. voiceFeedbackAccessibilityEnabled: type: boolean example: true description: Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device. dialAssistEnabled: type: boolean example: true description: Enable/disable availability of dial assist feature on the phone. callsPerLine: type: number example: 9 description: Specify the number of calls per unique line appearance on the phone. nightlyResyncEnabled: type: boolean example: true description: Enable/disable automatic nightly configuration resync of the MPP device. missedCallNotificationEnabled: type: boolean example: true description: Enable/disable the visual indication of missed calls. softKeyLayout: $ref: '#/components/schemas/SoftKeyLayoutObject' description: Specify the softkey layout per phone menu state. backgroundImage8875: $ref: '#/components/schemas/BackgroundImageColor' description: Specify the image option for the MPP 8875 phone background. backlightTimer68XX78XX: $ref: '#/components/schemas/BacklightTimer68XX' description: Specify the use of the backlight feature on 6800 nad 7800 series devices. allowMonitorLinesEnabled: type: boolean description: Enable/disable monitoring for MPP non-primary device. iceEnabled: type: boolean example: true description: Enable/disable SIP media streams to go directly between phones on the same local network. LdapObjectDevice: type: object required: - enabled properties: enabled: type: boolean description: Sets the values needed to enable use of the LDAP service on the phone. serverAddress: type: string example: localhost description: Sets the values needed to enable use of the LDAP service on the phone. serverPort: type: number example: 8080 description: Sets the values needed to enable use of the LDAP service on the phone. commSecurityType: $ref: '#/components/schemas/CommSecurityType' description: Indicates the selection of the protocol for LDAP service on the phone. bindDn: type: string example: bindDn description: Sets the values needed to enable use of the LDAP service on the phone. bindPw: type: string example: bindPw description: Sets the values needed to enable use of the LDAP service on the phone. baseDn: type: string example: baseDn description: Sets the values needed to enable use of the LDAP service on the phone. primaryEmailAttribute: type: string example: primaryEmailAttribute description: Sets the values needed to enable use of the LDAP service on the phone. alternateEmailAttribute: type: string example: alternateEmailAttribute description: Sets the values needed to enable use of the LDAP service on the phone. StartJobResponse: type: object required: - name - id - jobType - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - operationType - sourceLocationId - targetLocationId - counts properties: name: type: string example: managenumbers description: Job name. id: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU description: Unique identifier of the job. jobType: type: string example: managenumbers description: Job type. trackingId: type: string example: ATLAS_06a92f81-244d-4fd2-b8db-121bc1eeb6c8_11 description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM description: Unique identifier to identify the customer for which the job was run. instanceId: type: number example: 238972 description: Unique identifier to identify the instance of the job. jobExecutionStatus: type: array items: $ref: '#/components/schemas/JobExecutionStatusObject1' 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" operationType: type: string example: MOVE description: The operation type that was carried out. sourceLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E2MmRlOWRkLWRmODEtNDg3My04MGY5LTY2MmYyZmM3ZTI2NQ description: Unique location identifier for which the job was run. targetLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw description: Unique location identifier for which the numbers have been moved. counts: $ref: '#/components/schemas/CountObject' description: Job statistics. BacklightTimer68XXDevice: type: string enum: - ALWAYS_ON - TEN_SEC - TWENTY_SEC - THIRTY_SEC - 'OFF' description: " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n" mppObjectDevice: type: object required: - pnacEnabled - audioCodecPriority - backlightTimer - background - cdpEnabled - defaultLoggingLevel - dndServicesEnabled - acd - shortInterdigitTimer - longInterdigitTimer - lineKeyLabelFormat - lineKeyLEDPattern - lldpEnabled - mppUserWebAccessEnabled - multicast - enhancedMulticast - offHookTimer - phoneLanguage - poeMode - qosEnabled - screenTimeout - usbPortsEnabled - usbPorts - vlan - wifiNetwork - callHistory - contacts - webexMeetingsEnabled - volumeSettings - cfExpandedSoftKey - httpProxy - bluetooth - passThroughPortEnabled - userPasswordOverrideEnabled - activeCallFocusEnabled - peerFirmwareEnabled - noiseCancellation - voiceFeedbackAccessibilityEnabled - dialAssistEnabled - callsPerLine - nightlyResyncEnabled - missedCallNotificationEnabled - softKeyLayout - backgroundImage8875 - backlightTimer68XX78XX - allowMonitorLinesEnabled properties: pnacEnabled: type: boolean example: true description: Indicates whether the PNAC of MPP object is enabled or not. audioCodecPriority: $ref: '#/components/schemas/MppAudioCodecPriorityObjectDevice' description: Choose up to three predefined codec priority options available for your region. backlightTimer: $ref: '#/components/schemas/BacklightTimerObjectDevice' description: Choose the length of time (in minutes) for the phone's backlight to remain on. background: type: object properties: image: $ref: '#/components/schemas/BackgroundImage' customUrl: type: string displayNameFormat: $ref: '#/components/schemas/DisplayNameSelection' description: The display name that appears on the phone screen. cdpEnabled: type: boolean description: Allows you to enable/disable CDP for local devices. defaultLoggingLevel: $ref: '#/components/schemas/DefaultLoggingLevelObject' description: Choose the desired logging level for an MPP devices. dndServicesEnabled: type: boolean example: true description: Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones. acd: $ref: '#/components/schemas/AcdObjectDevice' description: Holds the Acd object value. shortInterdigitTimer: type: number example: 14 description: Indicates the short inter digit timer value. longInterdigitTimer: type: number example: 16 description: Indicates the long inter digit timer value.. lineKeyLabelFormat: $ref: '#/components/schemas/LineKeyLabelSelection' description: Line key labels define the format of what's shown next to line keys. lineKeyLEDPattern: $ref: '#/components/schemas/LineKeyLEDPattern' description: LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875 lldpEnabled: type: boolean description: Enable/disable Link Layer Discovery Protocol for local devices. mppUserWebAccessEnabled: type: boolean example: true description: Enable/disable user-level access to the web interface of Multi-Platform Phones. multicast: type: array items: type: string example: '["192.86.108.226:22"]' description: Select up to 10 Multicast Group URLs (each with a unique Listening Port). enhancedMulticast: $ref: '#/components/schemas/EnhancedMulticastObject' description: Specify the enhanced multicast settings for the MPP device. offHookTimer: type: number example: 30 description: Specify the amount of time (in seconds) that a phone can remain off-hook. phoneLanguage: $ref: '#/components/schemas/PhoneLanguage' description: Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location. poeMode: $ref: '#/components/schemas/PoeMode' description: Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones. qosEnabled: type: boolean example: true description: Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform. screenTimeout: $ref: '#/components/schemas/ScreenTimeoutObject' description: Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates. usbPortsEnabled: type: boolean example: true description: Enable/disable the use of the USB ports on Multi-Platform phones. usbPorts: $ref: '#/components/schemas/UsbPortsObject' description: By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port. vlan: $ref: '#/components/schemas/MppVlanObjectDevice' description: Specify a numeric Virtual LAN ID for devices. wifiNetwork: $ref: '#/components/schemas/WifiNetworkObjectDevice' description: Specify the Wi-Fi SSID and password for wireless-enabled MPP phones. callHistory: $ref: '#/components/schemas/CallHistoryMethod' description: Specify the call history information to use. Only applies to user devices. contacts: $ref: '#/components/schemas/DirectoryMethod' description: Specify the directory services to use. webexMeetingsEnabled: type: boolean example: true description: Enable/disable the availability of the webex meetings functionality from the phone. volumeSettings: $ref: '#/components/schemas/VolumeSettingsObject' description: Specify all volume level values on the phone. cfExpandedSoftKey: $ref: '#/components/schemas/CallForwardExpandedSoftKey' description: Specify the call forward expanded soft key behavior. httpProxy: $ref: '#/components/schemas/HttpProxyObjectDevice' description: Specify HTTP Proxy values. bluetooth: $ref: '#/components/schemas/BluetoothObjectDevice' description: Enable/disable the visibility of the bluetooth menu on the MPP device. passThroughPortEnabled: type: boolean example: true description: Enable/disable the use of the PC passthrough ethernet port on supported phone models. userPasswordOverrideEnabled: type: boolean example: true description: Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device. activeCallFocusEnabled: type: boolean example: true description: Enable/disable the default screen behavior when inbound calls are received. peerFirmwareEnabled: type: boolean example: true description: Enable/disable peer firmware sharing. noiseCancellation: $ref: '#/components/schemas/NoiseCancellationObject' description: Enable/disable local noise cancellation on active calls from the device. voiceFeedbackAccessibilityEnabled: type: boolean example: true description: Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device. dialAssistEnabled: type: boolean example: true description: Enable/disable availability of dial assist feature on the phone. callsPerLine: type: number example: 9 description: Specify the number of calls per unique line appearance on the phone. nightlyResyncEnabled: type: boolean example: true description: Enable/disable automatic nightly configuration resync of the MPP device. missedCallNotificationEnabled: type: boolean example: true description: Enable/disable the visual indication of missed calls. softKeyLayout: $ref: '#/components/schemas/SoftKeyLayoutObject' description: Specify the softkey layout per phone menu state. backgroundImage8875: $ref: '#/components/schemas/BackgroundImageColor' description: Specify the image option for the MPP 8875 phone background. backlightTimer68XX78XX: $ref: '#/components/schemas/BacklightTimer68XXDevice' description: Specify the use of the backlight feature on 6800 nad 7800 series devices. allowMonitorLinesEnabled: type: boolean description: Enable/disable monitoring for MPP non-primary device. iceEnabled: type: boolean example: true description: Enable/disable SIP media streams to go directly between phones on the same local network. AudioCodecPriorityObjectDevice: type: object required: - selection - primary - secondary - tertiary properties: selection: $ref: '#/components/schemas/SelectionType' description: Indicates the selection of an Audio Codec Priority Object. primary: type: string example: G711a description: Indicates the primary Audio Codec. secondary: type: string example: G711u description: Indicates the secondary Audio Codec. tertiary: type: string example: G729a description: Indicates the tertiary Audio Codec. DeviceLineType: type: string enum: - PRIMARY - SHARED_CALL_APPEARANCE - MOBILITY - HOTDESKING_GUEST 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 * `MOBILITY` - Device is a shared line.\n * `HOTDESKING_GUEST` - Device is a hotdesking guest.\n" JobExecutionStatusObject1: type: object required: - id - lastUpdated - statusMessage - createdTime - timeElapsed properties: id: type: number example: 239748 description: Unique identifier that identifies each instance of the job. lastUpdated: type: string example: '2022-08-24T06:18:38.825Z' description: Last updated time (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: '2022-08-24T06:18:31.070Z' description: Job creation time in UTC format. timeElapsed: type: string example: PT7.22S description: Time lapsed since the job execution started. BackgroundImage: type: string enum: - NONE - DARK_BLUE - CISCO_DARK_BLUE - WEBEX_DARK_BLUE - CUSTOM_BACKGROUND description: " * `NONE` - Indicates that there will be no background image set for the devices.\n * `DARK_BLUE` - Indicates that dark blue background image will be set for the devices.\n * `CISCO_DARK_BLUE` - Indicates that Cisco themed dark blue background image will be set for the devices.\n * `WEBEX_DARK_BLUE` - Indicates that Cisco Webex dark blue background image will be set for the devices.\n * `CUSTOM_BACKGROUND` - Indicates that a custom background image will be set for the devices.\n * `customUrl` - When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.\n" SnmpObject: type: object required: - enabled - trustedIP - getCommunity - setCommunity - snmpV3Enabled properties: enabled: type: boolean description: Denotes whether the Simple Network Management Protocol of an ATA is enabled. trustedIP: type: string example: 10.0.0.45 description: 'Trusted IPv4 address and subnet mask in this order: 0.0.0.0/0.0.0.0.' getCommunity: type: string example: public description: Read-only community string that allows/denies access to other device's statistics. Default value is `public`. setCommunity: type: string example: private description: Read-write community string that protects the device against unauthorized changes. Must never be set to `public`. snmpV3Enabled: type: boolean description: Denotes whether the SNMPv3 security is enabled. LineKeyType: type: string enum: - PRIMARY_LINE - SHARED_LINE - MONITOR - CALL_PARK_EXTENSION - SPEED_DIAL - OPEN - CLOSED - MODE_MANAGEMENT description: " * `PRIMARY_LINE` - PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.\n * `SHARED_LINE` - Shows the appearance of other users on the owner's phone.\n * `MONITOR` - Enables User and Call Park monitoring.\n * `CALL_PARK_EXTENSION` - Enables the configure layout feature in Control Hub to set call park extension implicitly.\n * `SPEED_DIAL` - Allows users to reach a telephone number, extension or a SIP URI.\n * `OPEN` - An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.\n * `CLOSED` - Button not usable but reserved for future features.\n * `MODE_MANAGEMENT` - Allows users to manage call forwarding for features via schedule-based routing.\n" GetThirdPartyDeviceObject: type: object required: - manufacturer - managedBy - id - ip - model - upgradeChannelEnabled properties: manufacturer: type: string example: THIRD_PARTY description: Manufacturer of the device. managedBy: type: string example: CUSTOMER description: Device manager(s). id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3 description: A unique identifier for the device. ip: type: string example: 100.110.120.130 description: The current IP address of the device. mac: type: string example: 11223344AAFF description: The unique address for the network adapter. model: type: string example: DMS Cisco 8811 description: A model type of the device. activationState: $ref: '#/components/schemas/ActivationStates' description: Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex. description: type: array items: type: string example: device description description: Comma-separated array of tags used to describe the device. upgradeChannelEnabled: type: boolean example: true description: Enabled / disabled status of the upgrade channel. owner: type: object required: - sipUserName properties: sipUserName: type: string example: '392829' description: SIP authentication user name for the owner of the device. linePort: type: string example: lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com description: Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode. proxy: type: object properties: outboundProxy: type: string example: hs17.hosted-int.bcld.webex.com description: Outgoing server which the phone should use for all SIP requests. Not set if the response has no body. LineKeyLabelSelection: type: string enum: - PERSON_EXTENSION - PERSON_FIRST_THEN_LAST_NAME - PERSON_LAST_THEN_FIRST_NAME description: " * `PERSON_EXTENSION` - This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n" placeDevices: type: object required: - id - model - primaryOwner - type - hoteling - owner - activationState properties: id: type: string description: Unique identifier for a device. description: type: array items: type: string description: Comma separated array of tags used to describe device. model: type: string description: Identifier for device model. mac: type: string description: MAC address of device. ipAddress: type: string description: IP address of device. primaryOwner: type: boolean description: Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device. type: $ref: '#/components/schemas/LineType' description: Indicates if the line is acting as a primary line or a shared line for this device. hoteling: $ref: '#/components/schemas/Hoteling' description: Indicates Hoteling details of a device. owner: $ref: '#/components/schemas/deviceOwner' description: Owner of the device. activationState: $ref: '#/components/schemas/DeviceActivationStates' description: Activation state of a device. LatestExecutionStatus: type: string enum: - STARTING - STARTED - COMPLETED - FAILED description: " * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has been completed.\n * `FAILED` - Job has failed.\n" ProgrammableLineKeys: type: object required: - lineKeyIndex - lineKeyType - sharedLineIndex properties: lineKeyIndex: type: number example: 2 description: An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone. lineKeyType: $ref: '#/components/schemas/LineKeyType' description: The action that would be performed when the Line Key is pressed. lineKeyLabel: type: string example: Help Line description: This is applicable only when the lineKeyType is `SPEED_DIAL`. lineKeyValue: type: string example: '5646' description: 'Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`).' sharedLineIndex: type: number example: 4 description: Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line. deleteImageResponseSuccessObject: type: object required: - fileName - result properties: fileName: type: string example: CompanyLogoBlue description: The name of the image file. result: type: object required: - status properties: status: type: number example: 200 description: The status of the deletion. description: The result of the deletion. 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' LineKeyLEDPattern: type: string enum: - DEFAULT - PRESET_1 wifiObject: type: object required: - audioCodecPriority - ldap - webAccess - phoneSecurityPwd properties: audioCodecPriority: $ref: '#/components/schemas/WifiAudioCodecPriorityObject' description: Choose up to three predefined codec priority options available for your region. ldap: $ref: '#/components/schemas/LdapObject' description: Set the values needed to enable use of the LDAP service on the phone. webAccess: $ref: '#/components/schemas/WebAccessObject' description: Set the availability of the local end user web access for an 840/860 WiFi phone. phoneSecurityPwd: type: string example: phoneSecurityPwd description: Set the local security password on an 840/860 WiFi phone. AcdObject: type: object required: - enabled - displayCallqueueAgentSoftkeys properties: enabled: type: boolean example: true description: Indicates whether the ACD object is enabled. displayCallqueueAgentSoftkeys: $ref: '#/components/schemas/DisplayCallqueueAgentSoftkeysObject' description: Indicates the call queue agent soft key value of an ACD object. PutDeviceSettingsRequest: type: object required: - customizations - customEnabled properties: customizations: $ref: '#/components/schemas/CustomizationDeviceLevelObjectDevice' description: Indicates the customization object of the device settings. customEnabled: type: boolean example: true description: Indicates if customization is allowed at a device level. If true, customized at a device level. If false, not customized; uses customer-level configuration. CustomizationDeviceLevelObject: type: object properties: ata: $ref: '#/components/schemas/ataObject' description: Applicable device settings for an ATA device. mpp: $ref: '#/components/schemas/mppObject' description: Applicable device settings for an MPP device. wifi: $ref: '#/components/schemas/wifiObject' description: Applicable device settings for a WiFi device. 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. BluetoothObject: type: object required: - enabled - mode properties: enabled: type: boolean example: true description: Enable/disable Bluetooth. mode: type: string enum: - PHONE description: Select a Bluetooth mode. PHONE: type: string HANDS_FREE: type: string BOTH: type: string AdminBatchStartJobObjectLocationCustomizations: type: object properties: locationId: type: string example: '''Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA''' description: Location within an organization where changes of device setings will be applied to all the devices within it. locationCustomizationsEnabled: type: boolean description: Indicates if all the devices within this location will be customized with new requested customizations(if set to `true`) or will be overridden with the one at organization level (if set to `false` or any other value). This field has no effect when the job is being triggered at organization level. customizations: $ref: '#/components/schemas/CustomizationObject' description: Indicates the settings for ATA devices, DECT devices and MPP devices. deleteImageRequestObject: type: object required: - fileName properties: fileName: type: string example: CompanyLogoBlue description: The name of the image file to be deleted. forceDelete: type: boolean example: true description: Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted, the background image is set to `None`. EnhancedMulticastObject: type: object required: - multicastList properties: xmlAppUrl: type: string example: http://127.0.0.1:8080/ description: Specify the URL for the XML application. multicastList: type: array items: $ref: '#/components/schemas/MulticastObject' description: Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout. deviceList: type: object required: - devices - maxDeviceCount - maxOwnedDeviceCount properties: devices: type: array items: $ref: '#/components/schemas/devices' description: Array of devices available to person. maxDeviceCount: type: number description: Maximum number of devices a person can be assigned to. maxOwnedDeviceCount: type: number description: Maximum number of devices a person can own. DisplayNameSelection: type: string enum: - PERSON_NUMBER - PERSON_FIRST_THEN_LAST_NAME - PERSON_LAST_THEN_FIRST_NAME description: " * `PERSON_NUMBER` - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n" WifiAudioCodecPriorityObject: type: object required: - selection - primary - secondary - tertiary properties: selection: $ref: '#/components/schemas/SelectionType' description: Indicates the selection of the Audio Codec Priority Object for an WiFi object. primary: type: string example: OPUS description: Indicates the primary Audio Codec for an WiFi object. secondary: type: string example: G722 description: Indicates the secondary Audio Codec for an WiFi object. tertiary: type: string example: G711u description: Indicates the tertiary Audio Codec for an WiFi object. 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" 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. MemberObject: type: object required: - id - firstName - lastName - primaryOwner - port - lineType - lineWeight - hotlineEnabled - hotlineDestination - allowCallDeclineEnabled - memberType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier for the member. firstName: type: string example: John description: First name of a person or workspace. lastName: type: string example: Smith description: Last name of a person or workspace. phoneNumber: type: string example: '2055552221' description: Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update. extension: type: string example: '000' description: Extension of a person or workspace. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '1234000' description: Routing prefix + extension of a person or workspace. primaryOwner: type: boolean example: true description: This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device. port: type: number example: 1 description: Port number assigned to person or workspace. t38FaxCompressionEnabled: type: boolean description: T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options. lineType: $ref: '#/components/schemas/LineType' description: Line type is used to differentiate Primary and SCA, at which endpoint it is assigned. lineWeight: type: number example: 1 description: Number of lines that have been configured for the person on the device. hostIP: type: string example: 10.0.0.45 description: Registration Host IP address for the line port. remoteIP: type: string example: 192.102.12.84 description: Registration Remote IP address for the line port. hotlineEnabled: type: boolean example: true description: Enable Hotline. 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: '+12055552222' description: The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true. allowCallDeclineEnabled: type: boolean example: true description: Set how a person's 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 only declines the current endpoint. lineLabel: type: string example: share line label description: Device line label. linePort: type: string example: evypzco5ds@55552222.int10.bcld.webex.com description: SIP username used in SIP signaling, for example, in registration. memberType: $ref: '#/components/schemas/MemberType' description: Indicates 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. AudioCodecPriorityObject: type: object required: - selection - primary - secondary - tertiary properties: selection: $ref: '#/components/schemas/SelectionType' description: Indicates the selection of an Audio Codec Priority Object. primary: type: string example: G711a description: Indicates the primary Audio Codec. secondary: type: string example: G711u description: Indicates the secondary Audio Codec. tertiary: type: string example: G729a description: Indicates the tertiary Audio Codec. MulticastObject: type: object required: - hostAndPort - hasXmlAppUrl properties: hostAndPort: type: string example: 224.0.0.0:22 description: Specify the multicast group URL and listening port. hasXmlAppUrl: type: boolean example: true description: Specify whether the multicast group URL has an XML application URL. xmlAppTimeout: type: number example: 10 description: Specify the timeout for the XML application. HttpProxyObjectDevice: type: object required: - mode - autoDiscoveryEnabled properties: mode: type: string enum: - 'OFF' - AUTO - MANUAL description: Mode of the HTTP proxy. autoDiscoveryEnabled: type: boolean example: true description: Enable/disable auto discovery of the URL. host: type: string example: www.example.wxc description: Specify the host URL if the HTTP mode is set to `MANUAL`. port: type: string example: '3128' description: Specify the port if the HTTP mode is set to `MANUAL`. packUrl: type: string example: www.example.wxc description: Specify PAC URL if auto discovery is disabled. authSettingsEnabled: type: boolean example: true description: Enable/disable authentication settings. username: type: string example: john description: Specify a username if authentication settings are enabled. password: type: string example: private description: Specify a password if authentication settings are enabled. Hoteling: type: object required: - enabled - limitGuestUse properties: enabled: type: boolean description: 'Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device as if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone.' limitGuestUse: type: boolean description: Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`. guestHoursLimit: type: number description: Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled. 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