openapi: 3.0.0 info: title: Webex Admin Address Book DECT Devices 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: DECT Devices Settings paths: /telephony/config/locations/{locationId}/dectNetworks: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - dectNetworkId properties: dectNetworkId: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf description: A unique identifier for the DECT network. example: dectNetworkId: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf '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 DECT Network operationId: Create a DECT Network description: 'Create a multi-cell DECT network for a given location. Creating a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Create a DECT network in this location. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd schema: type: string - name: orgId in: query description: Create a DECT network in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: test-dect displayName: test-dect model: DMS Cisco DBS210 defaultAccessCodeEnabled: true defaultAccessCode: '1551' schema: $ref: '#/components/schemas/CreateDECTNetwork' /telephony/config/dectNetworks: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTNetworkList' example: dectNetworks: - id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: Demo-DectNetwork displayName: Demo-DectNetwork chainId: 1224 model: DMS Cisco DBS210 defaultAccessCodeEnabled: true defaultAccessCode: '1234' numberOfBaseStations: 2 numberOfHandsetsAssigned: 5 numberOfLines: 2 location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: Cisco-HQ '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 List of DECT Networks for an organization operationId: Get the List of DECT Networks for an organization description: 'Retrieves the list of DECT networks for an organization. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: orgId in: query description: List of DECT networks in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: name in: query description: List of DECT networks with this name. example: Training-DectNetwork schema: type: string - name: locationId in: query description: List of DECT networks at this location. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTNetworkDetail' example: id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: Demo-DectNetwork displayName: Demo-DectNetwork chainId: 122456789 model: DMS Cisco DBS210 defaultAccessCodeEnabled: true defaultAccessCode: '1234' numberOfBaseStations: 2 numberOfHandsetsAssigned: 5 numberOfLines: 2 location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: Cisco-HQ '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 DECT Network Details operationId: Get DECT Network Details description: 'Retrieves the details of a DECT network. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Details of the DECT network at this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Details of the specified DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: orgId in: query description: Details of the DECT network 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 DECT Network operationId: Update DECT Network description: 'Update the details of a DECT network. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Update DECT network details in the specified location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Update DECT network details in the specified DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Update DECT network details in the specified organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: Demo-DectNetwork displayName: Demo-DectNetwork defaultAccessCodeEnabled: true defaultAccessCode: 1234 schema: $ref: '#/components/schemas/DECTNetworkPatch' 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 DECT Network operationId: Delete DECT Network description: 'Delete a DECT network. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Delete the DECT network in the specified location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Delete the specified DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Delete the DECT network in the specified organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/baseStations: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/BaseStationsPostResponse' example: baseStations: - mac: bbafec9a9027 result: status: 201 id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj '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 Multiple Base Stations operationId: Create Multiple Base Stations description: 'This API is used to create multiple base stations in a DECT network in an organization. Creating base stations in a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Create a base station in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: dectNetworkId in: path description: Create a base station for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA schema: type: string - name: orgId in: query description: Create a base station for a DECT network in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: baseStationMacs: - bbafec9a9027 - 6dde9ebde1c9 schema: type: object required: - baseStationMacs properties: baseStationMacs: type: array items: type: string description: Array of base station MAC addresses. get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BaseStationsListResponse' example: baseStations: - id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYWJjZDEyMzQtMzU2NC00MGMzLWE3YWQtNTY1MGZkZGRkNTOU mac: ABCD12555555 numberOfLinesRegistered: 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 a list of DECT Network Base Stations operationId: Get a list of DECT Network Base Stations description: 'Retrieve a list of base stations in a DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: dectNetworkId in: path description: Retrieve the list of base stations in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string 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 bulk DECT Network Base Stations operationId: Delete bulk DECT Network Base Stations description: 'Delete all the base stations in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: dectNetworkId in: path description: Delete all the base stations in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/baseStations/{baseStationId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BaseStationDetailResponse' example: id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5RG mac: ABBD45856978 handsets: - id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5PO displayName: Inventory-handset-1 accessCode: '1555' lines: - memberId: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5IU firstName: John lastName: Smith external: '+12555533333' extension: '1551' location: id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5LK name: Cisco-HQ memberType: PLACE '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 details of a specific DECT Network Base Station operationId: Get the details of a specific DECT Network Base Station description: 'Retrieve details of a specific base station in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: dectNetworkId in: path description: Retrieve details of a specific base station in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: baseStationId in: path description: Retrieve details of the specific DECT base station ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string 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 specific DECT Network Base Station operationId: Delete a specific DECT Network Base Station description: 'Delete a specific base station in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: dectNetworkId in: path description: Delete a specific base station in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: baseStationId in: path description: Delete the specific DECT base station ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/handsets: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Add a Handset to a DECT Network operationId: Add a Handset to a DECT Network description: 'Add a handset to a DECT network in a location in an organization. Adding a handset to a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
Adding a DECT handset to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
Adding or removing handsets to the DECT network in less than 90 seconds may result in base station not having the latest configuration until the base station is rebooted.
' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Add handset in this location. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd schema: type: string - name: dectNetworkId in: path description: A unique identifier for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf schema: type: string - name: orgId in: query description: Add handset in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: line1MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk line2MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk customDisplayName: handsetName schema: $ref: '#/components/schemas/AddDECTHandset' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTHandsetList' example: numberOfHandsetsAssigned: 1 numberOfLinesAssigned: 1 handsets: - id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz index: '1' defaultDisplayName: Demo_Handset customDisplayName: Demo_Handset accessCode: '4788' primaryEnabled: '' lines: - memberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: John lastName: Smith external: '+14088571272' extension: '3459' routingPrefix: '17636' esn: '176363459' location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: MainOffice memberType: PEOPLE '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 Handsets for a DECT Network ID operationId: Get List of Handsets for a DECT Network ID description: 'List all the handsets associated with a DECT Network ID. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OAss schema: type: string - name: dectNetworkId in: path description: Search handset details in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: basestationId in: query description: Search handset details in the specified DECT base station ID. example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj schema: type: string - name: memberId in: query description: ID of the member of the handset. Members can be of type PEOPLE, PLACE, or VIRTUAL_LINE. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/handsets/{handsetId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTHandsetGet' example: id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz index: '1' customDisplayName: Demo_Handset defaultDisplayName: Demo_Handset baseStationId: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj mac: 1357D4A1B492 accessCode: '4788' lines: - memberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: John lastName: Smith external: '+14088571272' extension: '3459' lastRegistrationTime: '1611229671234' hostIP: 10.0.0.45 remoteIP: 76.102.12.84 location: id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd name: MainOffice memberType: PEOPLE '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 Specific DECT Network Handset Details operationId: Get Specific DECT Network Handset Details description: 'List the specific DECT Network handset details. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Search handset details in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk schema: type: string - name: handsetId in: path description: A unique identifier for the handset. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz schema: type: string - name: orgId in: query description: Organization containing the DECT network. 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 DECT Network Handset operationId: Update DECT Network Handset description: "Update the line assignment on a handset.\n\nA handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.\nA member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.\n\nUpdating a DECT Network handset requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n
Adding a person with a Webex Calling Standard license to the DECT handset line1 will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications. \nRemoving a person with a Webex Calling Standard license from the DECT handset line1 will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
\n\n
Adding or removing handsets to the DECT network in less than 90 seconds may result in base station not having the latest configuration until the base station is rebooted.
" tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Update handset details in the specified DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: handsetId in: path description: A unique identifier for the handset. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: line1MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMlm line2MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk customDisplayName: handsetDisplayName schema: $ref: '#/components/schemas/DECTNetworkHandsetPatch' 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 specific DECT Network Handset Details operationId: Delete specific DECT Network Handset Details description: 'Delete a specific DECT Network handset. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
Deleting a DECT handset from a person with a Webex Calling Standard license will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
Adding or removing handsets to the DECT network in less than 90 seconds may result in base station not having the latest configuration until the base station is rebooted.
' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Delete handset details in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: handsetId in: path description: A unique identifier for the handset. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/handsets/: 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 multiple handsets operationId: Delete multiple handsets description: 'Delete multiple handsets or all of them. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
Deleting a DECT handset from a person with a Webex Calling Standard license will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
Adding or removing handsets to the DECT network in less than 90 seconds may result in base station not having the latest configuration until the base station is rebooted.
' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Location containing the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Delete handset details in the specified DECT network ID. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Organization containing the DECT network. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: handsetIds: - Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz - Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYjVhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNQ deleteAll: 'true' schema: $ref: '#/components/schemas/DECTNetworkHandsetsDeleteItem' /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/handsets/bulk: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/AddDECTHandsetBulkSuccessResponse' description: List of added handsets. example: items: - customDisplayName: handsetName1 result: status: 200 - customDisplayName: handsetName2 result: status: 200 '206': description: Partial Content headers: {} content: application/json: schema: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/AddDECTHandsetBulkPartialResponse' description: List of added handsets. example: items: - customDisplayName: handsetName1 result: status: 200 - customDisplayName: handsetName2 result: status: 400 error: message: '[Error 4516] Cannot assign user to device: {0} with line/Port: {1}' errorCode: 4516 '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: Add a List of Handsets to a DECT Network operationId: Add a List of Handsets to a DECT Network description: 'Add a list of up to 50 handsets to a DECT network in a location. A DECT network acts as a container that can support up to 1,000 lines across all handsets, with each handset capable of handling up to two lines. Once the network is created, you can add bases, handsets, and assign users or lines as needed. Adding a list of handsets to a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
Adding a DECT handset to a person with a Webex Calling Standard license will disable Webex Calling across their Webex mobile, tablet, desktop, and browser applications.
Adding or removing handsets to the DECT network in less than 90 seconds may result in base station not having the latest configuration until the base station is rebooted.
' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Add handsets in this location. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd schema: type: string - name: dectNetworkId in: path description: A unique identifier for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf schema: type: string - name: orgId in: query description: Add handsets in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: items: - line1MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk line2MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMjExMWFhZi1kNTFlLTRkNTMtODlhNS00NTcwNzQ1NGYyYWY customDisplayName: handsetName1 - line1MemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzNlZDRmYi05MzJiLTQyOTYtODMxNC1iZWY1ZmRlNGRmYjM customDisplayName: handsetName2 schema: $ref: '#/components/schemas/AddDECTHandsetBulkRequest' /telephony/config/people/{personId}/dectNetworks: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTNetworkListPerson' example: dectNetworks: - id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: Demo-DectNetwork numberOfHandsetsAssigned: 5 '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 DECT networks associated with a Person operationId: GET List of DECT networks associated with a Person description: 'Retrieves the list of DECT networks for a person in an organization. DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: personId in: path description: List of DECT networks associated with this person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: orgId in: query description: List of DECT networks associated with a person in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/workspaces/{workspaceId}/dectNetworks: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTNetworkListWorkspace' example: dectNetworks: - id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: Demo-DectNetwork numberOfHandsetsAssigned: 5 '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 DECT networks associated with a workspace operationId: GET List of DECT networks associated with a workspace description: 'Retrieves the list of DECT networks for a workspace in an organization. DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: workspaceId in: path description: List of DECT networks associated with this workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: orgId in: query description: List of DECT networks associated with a workspace in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/devices/availableMembers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableMembersResponse' example: members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk firstName: John lastName: Smith phoneNumber: '+12055552221' extension: '1234' lineType: PRIMARY memberType: PEOPLE location: id: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd name: MainOffice '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Search Available Members operationId: Search Available Members description: 'List the members that are available to be assigned to DECT handset lines. This requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - DECT Devices Settings parameters: - name: orgId in: query description: Search members 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: '+19828282867' schema: type: string - name: extension in: query description: Search (Contains) based on extension. example: '1234' schema: type: string - name: order in: query description: Sort the list of available members on the device in ascending order by name, using either last name `lname` or first name `fname`. Default sort is the last name in ascending order. example: lname schema: type: string - name: locationId in: query description: List members for the location ID. example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrk schema: type: string - name: excludeVirtualLine in: query description: 'If true, search results will exclude virtual lines in the member list. NOTE: Virtual lines cannot be assigned as the primary line.' example: 'true' schema: type: boolean - 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 /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/serviceabilityPassword/actions/generate/invoke: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/PostDECTServiceabilityPasswordResponse' example: password: ?i@9$?F)iR?rHNsu '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: Generate and Enable DECT Serviceability Password operationId: Generate and Enable DECT Serviceability Password description: 'Generates and enables a 16-character DECT serviceability password.
Generating a password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time to generate a new password.
The DECT serviceability password, also known as the admin override password, provides read/write access to DECT base stations for performing system serviceability and troubleshooting functions. This API requires either a full administrator auth token with the scope `spark-admin:telephony_config_write`, or a device administrator token with the scope of `spark-admin:devices_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Unique identifier for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/dectNetworks/{dectNetworkId}/serviceabilityPassword: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DECTServiceabilityPassword' example: enabled: '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 DECT Serviceability Password status operationId: Get DECT Serviceability Password status description: 'Retrieves the DECT serviceability password status.
If the serviceability password is enabled but has not been generated, the `enabled` status will be returned as `true` even though there is no active serviceability password.
The DECT serviceability password, also known as the admin override password, provides read/write access to DECT base stations for performing system serviceability and troubleshooting functions. This API requires an auth token with either a full, read-only token with the scope of `spark-admin:telephony_config_read`, or a device administrator token with the scope of `spark-admin:devices_read`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Unique identifier for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update DECT Serviceability Password status operationId: Update DECT Serviceability Password status description: 'Enables or disables the DECT serviceability password.
Enabling or disabling the password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time for this action.
If enabling is requested, but the serviceability password has not been generated, we will not actively reject the request even though there is no serviceability password.
The DECT serviceability password, also known as the admin override password, provides read/write access to DECT base stations for performing system serviceability and troubleshooting functions. This API requires either a full administrator auth token with the scope `spark-admin:telephony_config_write`, or a device administrator token with the scope of `spark-admin:devices_write`.' tags: - DECT Devices Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: dectNetworkId in: path description: Unique identifier for the DECT network. required: true example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk= schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: 'true' schema: $ref: '#/components/schemas/DECTServiceabilityPassword' components: schemas: DECTNetworkHandsetsDeleteItem: type: object required: - handsetIds properties: handsetIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz,Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYjVhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNQ description: Array of the handset IDs to be deleted. deleteAll: type: boolean example: true description: If present the items array is ignored and all items in the context are deleted. DECTNetworkDetail: type: object required: - id - name - chainId - model - defaultAccessCodeEnabled - defaultAccessCode - numberOfBaseStations - numberOfHandsetsAssigned - numberOfLines - location properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf description: Unique identifier for the DECT network. name: type: string example: Demo-DectNetwork description: Name of the DECT network. This should be unique across the location. displayName: type: string example: Demo-DectNetwork description: DECT network name displayed on the handset. chainId: type: number example: 1356802345 description: Chain ID of the DECT network. model: $ref: '#/components/schemas/BaseStationType' description: Base station model deployed in the DECT network. defaultAccessCodeEnabled: type: boolean example: true description: Default access code is enabled. If true, the default access code is mandatory. If false, auto-generated access code is used. defaultAccessCode: type: string example: '1234' description: Default access code for the DECT network. The default access code should be unique within the same location to avoid the handset accidentally registering with base stations from different DECT networks in range. This is mandatory when `defaultAccessCodeEnabled` is true. numberOfBaseStations: type: number example: 2 description: Number of base stations in the DECT network. numberOfHandsetsAssigned: type: number example: 5 description: Number of handsets assigned to the DECT network. numberOfLines: type: number example: 2 description: Number of lines in the DECT network. location: $ref: '#/components/schemas/location' description: Location of the DECT network. BaseStationPostResult: type: object required: - status properties: status: type: number example: 201 description: HTTP status code indicating the creation of base station. 201 status code indicates the successful creation of base stations. id: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj description: Unique identifier of the base station. AddDECTHandsetBulkSuccessResponse: type: object required: - customDisplayName - result properties: customDisplayName: type: string example: handsetDisplayName description: The custom display name on the handset. result: type: object required: - status properties: status: type: number example: 201 description: The status of the add handset request. description: The result of the add handset request. DECTNetworkListWorkspace: type: object properties: dectNetworks: type: array items: $ref: '#/components/schemas/DECTNetworkItem' description: List of DECT networks associated with the workspace. BaseStationsListResponse: type: object required: - baseStations properties: baseStations: type: array items: $ref: '#/components/schemas/BaseStationsResponse' description: List of base stations in a DECT Network. DECTNetworkItem: type: object required: - id - name - numberOfHandsetsAssigned properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf description: Unique identifier for the DECT network. name: type: string example: Demo-DectNetwork description: Name of the DECT network. This should be unique across the location. numberOfHandsetsAssigned: type: number example: 5 description: Number of handsets assigned to the DECT network. DECTHandsetLineResponse: type: object required: - memberId - firstName - lastName - external - extension - location - memberType properties: memberId: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5RG description: Unique identifier of the handset line member. firstName: type: string example: John description: First name of handset line member. lastName: type: string example: Smith description: Last name of handset line member. external: type: string example: '+12555533333' description: Primary number of handset line member. extension: type: string example: '1551' description: Extension of handset line member. location: $ref: '#/components/schemas/location' description: Location details of the handset line member. memberType: $ref: '#/components/schemas/MemberType' description: Indicates handset line member type. BaseStationDetailResponse: type: object required: - id - mac - handsets properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ description: Unique identifier of the base station. mac: type: string example: ABBD45856978 description: Mac address of the DECT base station device. handsets: type: array items: $ref: '#/components/schemas/HandsetsResponse' description: List of handset and member line details registered with the base station. DECTServiceabilityPassword: type: object required: - enabled properties: enabled: type: boolean example: true description: DECT serviceability password status. When `enabled` is set to `true`, the serviceability password can be used to manage DECT. When `enabled` is set to `false`, the serviceability password is disabled and the password owned and known by Cisco is required to perform serviceability and troubleshooting. BaseStationType: type: string enum: - DMS Cisco DBS210 - DMS Cisco DBS110 description: " * `DMS Cisco DBS210` - Cisco DBS210 base station model.\n * `DMS Cisco DBS110` - Cisco DBS110 base station model.\n" DECTHandsetList: type: object required: - numberOfHandsetsAssigned - numberOfLinesAssigned - handsets properties: numberOfHandsetsAssigned: type: number example: 1 description: Number of handsets associated. numberOfLinesAssigned: type: number example: 1 description: Total number of lines assigned. handsets: type: array items: $ref: '#/components/schemas/DECTHandsetItem' description: Array of `DECTHandsetItem` objects, each representing a handset with its associated details and lines. BaseStationsPostResponse: type: object required: - baseStations properties: baseStations: type: array items: $ref: '#/components/schemas/BaseStationResponse' description: List of base station MAC addresses that have to be added to the DECT network. AddDECTHandsetBulkPartialResponse: type: object required: - customDisplayName - result properties: customDisplayName: type: string example: handsetDisplayName description: The custom display name on the handset. result: type: object required: - status properties: status: type: number example: 400 description: The status of the add handset request. 200 indicates the handset was added successfully. error: type: object required: - message - errorCode properties: message: type: string example: '[Error 4516] Cannot assign user to device: {0} with line/Port: {1}' description: The error message. errorCode: type: number example: 4516 description: The error code. description: The error message if the add handset request failed. description: The result of the add handset request. DECTNetworkHandsetPatch: type: object required: - line1MemberId - customDisplayName properties: line1MemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMlm description: ID of the member on line1 of the handset. Members can be PEOPLE or PLACE. line2MemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID of the member on line2 of the handset. Members can be PEOPLE, PLACE, or VIRTUAL_LINE. customDisplayName: type: string example: handsetDisplayName description: Custom display name on the handset. CreateDECTNetwork: type: object required: - name - model - defaultAccessCodeEnabled - defaultAccessCode properties: name: type: string example: test-dect description: Name of the DECT network. Min and max length supported for the DECT network name are 1 and 40 respectively. displayName: type: string example: test-dect description: Add a default name (11 characters max) to display for all handsets. If left blank, the default name will be an indexed number followed by the DECT network name. model: type: string enum: - DMS Cisco DBS110 - Cisco DECT 110 Base - DMS Cisco DBS210 - Cisco DECT 210 Base description: "Select a device model type depending on the number of base stations and handset lines needed in the DECT network. The corresponding device model display name sometimes called the product name, can also be used to specify the model.\n * `DMS Cisco DBS110` - Model name supporting 1 base station and 30 line ports.\n * `Cisco DECT 110 Base` - Alternate product/display name which also specifies the model `DMS Cisco DBS110`.\n * `DMS Cisco DBS210` - Supports 250 base stations and 1000 line ports.\n * `Cisco DECT 210 Base` - Alternate product/display name which also specifies the model `DMS Cisco DBS210`.\n" defaultAccessCodeEnabled: type: boolean example: true description: 'If set to true, need to provide a default access code that will be shared for all users in this network to pair their lines to the next available handset. Otherwise, each user will get a unique 4-digit access code that will be auto-generated. Note: There is currently no public API to retrieve the auto generated access codes for handsets. Use Control Hub instead.' defaultAccessCode: type: string example: '1551' description: If `defaultAccessCodeEnabled` is set to true, then provide a default access code that needs to be a 4-numeric digit. The access code should be unique to the DECT network for the location. AddDECTHandsetBulkRequest: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/AddDECTHandset' maxItems: 50 minItems: 1 description: List of handsets that are to be added to the DECT network. 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" DECTNetworkList: type: object required: - dectNetworks properties: dectNetworks: type: array items: $ref: '#/components/schemas/DECTNetworkDetail' description: List of DECT networks in an organization. DECTHandsetItem: type: object required: - id - index - defaultDisplayName - lines properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX0hBTkRTRVQvYjE0MDYyOWUtZTExMy00ODQyLWIxMmMtMDVjODEwYTRjYjIz description: Unique identifier of the handset. index: type: string example: '1' description: Index of the handset. defaultDisplayName: type: string example: Demo_Handset description: Default display name for the handset. customDisplayName: type: string example: Demo_Handset description: Custom display name on the handset. accessCode: type: string example: '4788' description: Access code is used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected. primaryEnabled: type: boolean example: true description: Flags the handset as a primary line if `true`. lines: type: array items: $ref: '#/components/schemas/lines' description: Array of lines associated to the handset up to a maximum of 2. PostDECTServiceabilityPasswordResponse: type: object required: - password properties: password: type: string example: ?i@9$?F)iR?rHNsu description: 16-character serviceability password. lines: type: object required: - memberId - firstName - lastName - location - memberType properties: memberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID of the member on line1 of the handset. Members can be PEOPLE or PLACE. firstName: type: string example: John description: Line members's first name. lastName: type: string example: Smith description: Line members's last name. external: type: string example: '+14088571272' description: Line members primary number. extension: type: string example: '3459' description: Line members extension. lastRegistrationTime: type: string example: '1611229671234' description: Last registration timestamp. hostIP: type: string example: 10.0.0.45 description: Registration host IP address for the line port. remoteIP: type: string example: 76.102.12.84 description: Registration remote IP address for the line port. location: $ref: '#/components/schemas/location' description: Location object including a unique identifier for the location and its name. memberType: $ref: '#/components/schemas/MemberType' description: Indicates member type. BaseStationResponse: type: object required: - mac - result properties: mac: type: string example: 6DDE9EBDE1C9 description: MAC Address added to the base station. result: $ref: '#/components/schemas/BaseStationPostResult' description: Object with base station POST Result. DECTNetworkListPerson: type: object properties: dectNetworks: type: array items: $ref: '#/components/schemas/DECTNetworkItem' description: List of DECT networks associated with the person. AvailableMembersResponse: type: object properties: members: type: array items: $ref: '#/components/schemas/AvailableMember' BaseStationsResponse: type: object required: - id - mac - numberOfLinesRegistered properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ description: Unique identifier of the base station. mac: type: string example: ABBD45856978 description: Mac address of the DECT base station device. numberOfLinesRegistered: type: number example: 2 description: Number of handset member lines registered with the base station. 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" AvailableMember: type: object required: - id - firstName - lastName - lineType - memberType - location properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier for the member. firstName: type: string example: John description: First name of the member. lastName: type: string example: Smith description: Last name of the member. phoneNumber: type: string example: '+12055552221' description: Phone Number of the member. extension: type: string example: '1234' description: Extension of the member. lineType: $ref: '#/components/schemas/LineType' description: Line type indicates if the associated line is a primary line or a shared line. memberType: $ref: '#/components/schemas/MemberType' description: Indicates the type of the member. location: $ref: '#/components/schemas/location' description: Location object having a unique identifier for the location and its name. HandsetsResponse: type: object required: - id - displayName - accessCode - lines properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5RG description: Unique identifier of the DECT handset. displayName: type: string example: Inventory-handset-1 description: Display name of the DECT handset. accessCode: type: string example: '1558' description: Access code for the DECT handset. lines: type: array items: $ref: '#/components/schemas/DECTHandsetLineResponse' description: Details of the handset member lines registered with the base station. The maximum number of lines supported is 2. DECTHandsetGet: type: object required: - id - index - defaultDisplayName - baseStationId - mac - lines properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd description: Unique identifier of the handset. index: type: string example: '1' description: Index of the handset. customDisplayName: type: string example: Demo_Handset description: Custom display name for the handset. defaultDisplayName: type: string example: Demo_Handset description: Default display name for the handset. baseStationId: type: string example: Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj description: Unique identifier of the associated base station. mac: type: string example: 1357D4A1B492 description: MAC Address associated with the handset. accessCode: type: string example: '4788' description: Access code used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected. lines: type: array items: $ref: '#/components/schemas/lines' description: 'Array of lines associated with the handset. Maximum: 2 lines.' 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. AddDECTHandset: type: object required: - line1MemberId - customDisplayName properties: line1MemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID of the member on line1 of the handset. Members can be PEOPLE or PLACE. line2MemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID of the member on line2 of the handset. Members can be PEOPLE, PLACE, or VIRTUAL_LINE. customDisplayName: type: string example: handsetDisplayName description: Custom display name on the handset. Min and max length supported for the custom display name is 1 and 16 respectively. DECTNetworkPatch: type: object required: - name - defaultAccessCodeEnabled - defaultAccessCode properties: name: type: string example: Demo-DectNetwork description: Name of the DECT network. This should be unique across the location. displayName: type: string example: Demo-DectNetwork description: DECT network name that will be displayed on the handset. defaultAccessCodeEnabled: type: boolean example: true description: Default access code is enabled. If true, the default access code is mandatory. If false, an auto-generated access code is used. defaultAccessCode: type: string example: '1234' description: Default access code for the DECT network. The default access code should be unique within the same location to avoid the handset accidentally registering with base stations from different DECT networks in range. This is mandatory when `defaultAccessCodeEnabled` is true. 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