openapi: 3.0.0 info: title: Webex Admin Address Book Emergency Services 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: Emergency Services Settings paths: /telephony/config/redSky/serviceSettings: 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 RedSky Service Settings operationId: Update RedSky Service Settings description: 'Update the RedSky service settings. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Updating the RedSky service settings requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Update E911 settings for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true companyId: a5e5808f-34ac-4ed0-b8f3-2416bc4cb785 secret: qwEr4%2d externalTenantEnabled: true email: test@cisco.com password: Test@123 schema: $ref: '#/components/schemas/RedSkyServiceSettingsObject' /telephony/config/redSky: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create an Account and Admin in RedSky operationId: Create an Account and Admin in RedSky description: 'Create an account and admin in RedSky. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Creating a RedSky account requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Create RedSky account for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RedSkyCreateObject' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RedSkyGetObject' example: enabled: true companyId: a5e5808f-34ac-4ed0-b8f3-2416bc4cb785 secret: '*****' locationsEnabled: 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: Retrieve RedSky Account Details for an Organization operationId: Retrieve RedSky Account Details for an Organization description: 'Retrieve RedSky account details for an organization. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. To retrieve the RedSky account details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Retrieve RedSky account for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/redSky/status: put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ComplianceStatusResponse' example: orgStatus: INITIALISE complianceStatus: NON_COMPLIANT companyId: ddd1424c-5b48-433d-9bab-061cdfb84c90 redSkyOrgId: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 adminExists: true locationsStatus: state: LOCATION_SETUP count: 2 locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA 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: Update the Organization RedSky Account's Compliance Status operationId: Update the Organization RedSky Account's Compliance Status description: 'Update the compliance status for the customer''s RedSky account. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Updating the RedSky account''s compliance status requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Update E911 compliance status for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: complianceStatus: LOCATION_SETUP schema: $ref: '#/components/schemas/RedSkyComplianceStatusRequestObject' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ComplianceStatusResponse' example: orgStatus: INITIALISE complianceStatus: NON_COMPLIANT companyId: ddd1424c-5b48-433d-9bab-061cdfb84c90 redSkyOrgId: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 adminExists: true locationsStatus: state: LOCATION_SETUP count: 2 locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA 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: Get the Organization Compliance Status for a RedSky Account operationId: Get the Organization Compliance Status for a RedSky Account description: 'Get the organization compliance status for a RedSky account. The `locationStatus.state` in the response will show the state for the location that is in the earliest stage of configuration. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. To retrieve organization compliance status requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Retrieve the compliance status for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string /telephony/config/redSky/complianceStatus: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetComplianceStatusResponse' example: orgStatus: INITIALISE complianceStatus: NON_COMPLIANT companyId: ddd1424c-5b48-433d-9bab-061cdfb84c90 redSkyOrgId: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 adminExists: true locationsStatus: count: 2 locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA name: MainOffice state: LOCATION_SETUP '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 Organization Compliance Status and the Location Status List operationId: Get the Organization Compliance Status and the Location Status List description: 'Get the organization compliance status and the location status list for a RedSky account. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. To retrieve organization compliance status requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Retrieve the compliance status and the list of location statuses for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM 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: order in: query description: Sort the list of locations in ascending or descending order. To sort in descending order append `-desc` to possible sort order values. Possible sort order values are `locationName` and `locationState`. example: locationName-asc schema: type: string /telephony/config/redSky/actions/login/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LoginResponse' example: accountMatch: true externalTenantEnabled: true companyId: ddd1424c-5b48-433d-9bab-061cdfb84c90 '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: Login to a RedSky Admin Account operationId: Login to a RedSky Admin Account description: 'Login to Redsky for an existing account admin user to retrieve the `companyId` and verify the status of `externalTenantEnabled`. The password provided will not be stored. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. Logging in requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Login to a RedSky account for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string requestBody: content: application/json: example: email: test@cisco.com password: Test@123 redSkyOrgId: 610af8f4-a4ed-4be3-ae6f-efcdcd4895a8 schema: $ref: '#/components/schemas/LoginRequest' /telephony/config/locations/{locationId}/redSky: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLocationCallingParamtersResponse' example: integrationEnabled: true routingEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Location's RedSky Emergency Calling Parameters operationId: Get a Location's RedSky Emergency Calling Parameters description: 'Get the Emergency Calling Parameters for a specific location. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. To retrieve location calling parameters requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Retrieve Calling Parameters for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: Retrieve Calling Parameters for the location in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string /telephony/config/locations/{locationId}/redSky/status: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLocationComplianceStatusResponse' example: orgStatus: INITIALISE complianceStatus: NON_COMPLIANT companyId: ddd1424c-5b48-433d-9bab-061cdfb84c90 redSkyOrgId: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 adminExists: true locationsStatus: state: LOCATION_SETUP count: 2 locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA 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: Get a Location's RedSky Compliance Status operationId: Get a Location's RedSky Compliance Status description: 'Get RedSky compliance status for a specific location. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. Retrieving the location''s compliance status requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Retrieve the compliance status for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: Retrieve compliance status for the location in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UpdateLocationComplianceStatusResponse' example: locationsStatus: state: LOCATION_SETUP count: 2 locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA 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: Update a Location's RedSky Compliance Status operationId: Update a Location's RedSky Compliance Status description: 'Update the compliance status for a specific location. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Updating the RedSky account''s compliance status requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Update the E911 compliance status for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: Update the E911 compliance status for the location in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: complianceStatus: LOCATION_SETUP schema: $ref: '#/components/schemas/RedSkyComplianceStatusRequestObject' /telephony/config/locations/{locationId}/redSky/building: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a RedSky Building Address and Alert Email for a Location operationId: Create a RedSky Building Address and Alert Email for a Location description: 'Add a RedSky building address and alert email for a specified location. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Creating a building address and alert email requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Create the building address and alert email for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: The organization in which the location exists. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: alertingEmail: test@cisco.com address: addressLine1: 170 West Tasman Dr addressLine2: Building 6 city: San Jose stateOrProvince: California zipOrPostalCode: '95134' country: US schema: $ref: '#/components/schemas/CreateBuildingRequest' 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 a RedSky Building Address for a Location operationId: Update a RedSky Building Address for a Location description: 'Update a RedSky building address for a specified location. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account. Updating a building address requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Update the building address for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: The organization in which the location exists. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: address: addressLine1: 170 West Tasman Dr addressLine2: Building 6 city: San Jose stateOrProvince: California zipOrPostalCode: '95134' country: US schema: $ref: '#/components/schemas/UpdateBuildingRequest' /telephony/config/emergencyCallNotification: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/OrgCallNotificationObject' example: emergencyCallNotificationEnabled: true allowEmailNotificationAllLocationEnabled: true emailAddress: callback@gmail.com '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 an Organization Emergency Call Notification operationId: Get an Organization Emergency Call Notification description: 'Get organization emergency call notification. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that''s made from within your organization to emergency services must generate an email notification. To retrieve organization call notifications requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Retrieve Emergency Call Notification attributes for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM 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 an Organization Emergency Call Notification operationId: Update an Organization Emergency Call Notification description: 'Update an organization emergency call notification. Once settings are enabled at the organization level, the configured email address will receive emergency call notifications for all locations. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that''s made from within your organization to emergency services must generate an email notification. To update organization call notification requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: orgId in: query description: Update Emergency Call Notification attributes for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string requestBody: content: application/json: example: emergencyCallNotificationEnabled: true allowEmailNotificationAllLocationEnabled: true emailAddress: callback@gmail.com schema: $ref: '#/components/schemas/OrgCallNotificationObject' /telephony/config/locations/{locationId}/emergencyCallNotification: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLocationCallNotificationObject' example: emergencyCallNotificationEnabled: true emailAddress: callback@gmail.com organization: emergencyCallNotificationEnabled: true allowEmailNotificationAllLocationEnabled: true emailAddress: callback@gmail.com '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 Location Emergency Call Notification operationId: Get a Location Emergency Call Notification description: 'Get location emergency call notification. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. Once activated at the organization level, individual locations can configure this setting to direct notifications to specific email addresses. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that''s made from within your organization to emergency services must generate an email notification. To retrieve location call notifications requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Retrieve Emergency Call Notification attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: Retrieve Emergency Call Notification attributes for the location in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM 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 a Location Emergency Call Notification operationId: Update a Location Emergency Call Notification description: 'Update a location emergency call notification. Once settings enabled at the organization level, the configured email address will receive emergency call notifications for all locations; for specific location customization, users can navigate to Management > Locations, select the Calling tab, and update the Emergency Call Notification settings. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. Once activated at the organization level, individual locations can configure this setting to direct notifications to specific email addresses. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that''s made from within your organization to emergency services must generate an email notification. To update location call notification requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: locationId in: path description: Update Emergency Call Notification attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg schema: type: string - name: orgId in: query description: Update Emergency Call Notification attributes for a location in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string requestBody: content: application/json: example: emergencyCallNotificationEnabled: true emailAddress: callback@gmail.com schema: $ref: '#/components/schemas/PutLocationCallNotificationObject' /telephony/config/huntGroups/{huntGroupId}/emergencyCallbackNumber/dependencies: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetHuntGroupCallbackNumberDependenciesObject' example: isLocationEcbnDefault: true isSelfEcbnDefault: false dependentMemberCount: 0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Dependencies for a Hunt Group Emergency Callback Number operationId: Get Dependencies for a Hunt Group Emergency Callback Number description: 'Retrieves the emergency callback number dependencies for a specific hunt group. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group. Retrieving the dependencies requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: huntGroupId in: path description: Unique identifier for the hunt group. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Retrieve Emergency Callback Number attributes for the hunt group under this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string /telephony/config/people/{personId}/emergencyCallbackNumber: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetPersonCallbackNumberObject' example: selected: DIRECT_LINE directLineInfo: phoneNumber: '+18164196065' firstName: backUpworkspace lastName: . effectiveLevel: DIRECT_LINE effectiveValue: '+18164196065' quality: RECOMMENDED locationECBNInfo: phoneNumber: '+18164196065' lastName: . effectiveLevel: DIRECT_LINE effectiveValue: '+18164196065' quality: RECOMMENDED firstName: backUpworkspace locationMemberInfo: phoneNumber: '+18164196065' firstName: backUpworkspace lastName: . memberId: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg effectiveLevel: LOCATION_MEMBER_NUMBER effectiveValue: '+18164196065' quality: RECOMMENDED memberType: PLACE elinEnabled: false elinForWebexAppEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Person's Emergency Callback Number operationId: Get a Person's Emergency Callback Number description: 'Retrieve a person''s emergency callback number settings. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. To retrieve a person''s callback number requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization within which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM 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 a Person's Emergency Callback Number operationId: Update a Person's Emergency Callback Number description: 'Update a person''s emergency callback number settings. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. To update an emergency callback number requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization within which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string requestBody: content: application/json: example: selected: LOCATION_MEMBER_NUMBER locationMemberId: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg elinEnabled: false elinForWebexAppEnabled: false schema: $ref: '#/components/schemas/PutPersonECBNObject' /telephony/config/people/{personId}/emergencyCallbackNumber/dependencies: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetPersonCallbackNumberDependenciesObject' example: isLocationEcbnDefault: true isSelfEcbnDefault: false dependentMemberCount: 0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve A Person's Emergency Callback Number Dependencies operationId: Retrieve A Person's Emergency Callback Number Dependencies description: 'Retrieve Emergency Callback Number dependencies for a person. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. Retrieving the dependencies requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Retrieve Emergency Callback Number attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string /telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetWorkspaceCallbackNumberObject' example: selected: DIRECT_LINE directLineInfo: phoneNumber: '+18164196065' firstName: backUpworkspace lastName: . effectiveLevel: DIRECT_LINE effectiveValue: '+18164196065' quality: RECOMMENDED locationECBNInfo: phoneNumber: '+18164196065' lastName: . effectiveLevel: DIRECT_LINE effectiveValue: '+18164196065' quality: RECOMMENDED firstName: backUpworkspace locationMemberInfo: phoneNumber: '+18164196065' firstName: backUpworkspace lastName: . memberId: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8wY2VlYjFmYy04ZmEyLTQ5OGEtYWM3Ni02N2MyZGQ3MGQ2ZGY= effectiveLevel: LOCATION_MEMBER_NUMBER effectiveValue: '+18164196065' quality: RECOMMENDED memberType: PLACE elinEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Workspace Emergency Callback Number operationId: Get a Workspace Emergency Callback Number description: 'Retrieve the emergency callback number setting associated with a specific workspace. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. To retrieve an emergency callback number, it requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: workspaceId in: path description: Retrieve Emergency Callback Number attributes for this workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk schema: type: string - name: orgId in: query description: Retrieve Emergency Callback Number attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM 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 a Workspace Emergency Callback Number operationId: Update a Workspace Emergency Callback Number description: 'Update the emergency callback number settings for a workspace. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. To update an emergency callback number requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: workspaceId in: path description: Updating Emergency Callback Number attributes for this workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk schema: type: string - name: orgId in: query description: Updating Emergency Callback Number attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string requestBody: content: application/json: example: selected: LOCATION_MEMBER_NUMBER locationMemberId: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg elinEnabled: true schema: $ref: '#/components/schemas/PutWorkspaceECBNObject' /telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber/dependencies: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetWorkspaceCallbackNumberDependenciesObject' example: isLocationEcbnDefault: true isSelfEcbnDefault: false dependentMemberCount: 0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Workspace Emergency Callback Number Dependencies operationId: Retrieve Workspace Emergency Callback Number Dependencies description: 'Retrieve Emergency Callback Number dependencies for a workspace. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes. Retrieving the dependencies requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: workspaceId in: path description: Retrieve Emergency Callback Number attributes for this workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk schema: type: string - name: orgId in: query description: Retrieve Emergency Callback Number attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM schema: type: string /telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber/dependencies: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLinesECBNDependenciesObject' example: isLocationEcbnDefault: true isSelfEcbnDefault: true dependentMemberCount: 3 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Dependencies for a Virtual Line Emergency Callback Number operationId: Get Dependencies for a Virtual Line Emergency Callback Number description: 'Retrieves the emergency callback number dependencies for a specific virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users. Retrieving the dependencies requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY schema: type: string - name: orgId in: query description: List virtual lines for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VirtualLinesECBNObject' example: selected: DIRECT_LINE directLineInfo: phoneNumber: '9726856700' firstName: John lastName: Smith effectiveLevel: DIRECT_LINE effectiveValue: '9726856770' quality: RECOMMENDED locationECBNInfo: phoneNumber: '9726856701' firstName: Jane lastName: Smith effectiveLevel: LOCATION_ECBN effectiveValue: '9726856772' quality: RECOMMENDED locationMemberInfo: phoneNumber: '9726856703' firstName: Group Name lastName: . memberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI effectiveLevel: LOCATION_MEMBER_NUMBER effectiveValue: '9726856774' quality: RECOMMENDED 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 Virtual Line's Emergency Callback settings operationId: Get the Virtual Line's Emergency Callback settings description: 'Retrieves the emergency callback number settings for a specific virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users. Retrieving the dependencies requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Emergency Services Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY= schema: type: string - name: orgId in: query description: List virtual lines for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Virtual Line's Emergency Callback settings operationId: Update a Virtual Line's Emergency Callback settings description: 'Update the emergency callback number settings for a specific virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users. To update virtual line callback number requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Emergency Services Settings parameters: - name: virtualLineId in: path description: Unique identifier for the virtual line. required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY= schema: type: string - name: orgId in: query description: List virtual lines for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: selected: LOCATION_MEMBER_NUMBER locationMemberId: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg schema: $ref: '#/components/schemas/PutECBNObject' components: schemas: ComplianceStatusLocationStatusObject: type: object properties: state: $ref: '#/components/schemas/GetComplianceStatusResponseLocationStateEnum' description: Configuration stage that was last completed for the location in the request. The order of precedence is `LOCATION_SETUP`, `ALERTS`, `NETWORK_ELEMENTS`, `ROUTING_ENABLE`. count: type: number example: 2 description: Total count of the `locations` list. locations: type: array items: $ref: '#/components/schemas/ComplianceStatusResponseRedSkyClientLocation' description: Object that contains the `id` and the `name` for the location in the request. ComplianceStatusResponseRedSkyClientLocation: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA description: Unique identifier for the location. name: type: string example: MainOffice description: Name of the location. orgPrefixObject: type: string enum: - wxc - wxc-whs description: " * `wxc` - The customer is Webex calling.\n * `wxc-whs` - The customer is a wholesale.\n" GetLocationComplianceStatusResponse: type: object required: - orgStatus - complianceStatus properties: orgStatus: $ref: '#/components/schemas/OrgStatusEnum' description: The RedSky account configuration status for the organization. complianceStatus: $ref: '#/components/schemas/ComplianceStatusResponseEnum' description: The RedSky account's compliance status. companyId: type: string example: ddd1424c-5b48-433d-9bab-061cdfb84c90 description: The RedSky held token from the secret response. redSkyOrgId: type: string example: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 description: The RedSky organization ID for the organization which can be found in the RedSky portal. adminExists: type: boolean example: true description: '`true` if an Admin has been created in RedSky.' locationsStatus: $ref: '#/components/schemas/ComplianceStatusLocationStatusObject' description: Object that contains the `state`, `id`, and `name` for the `locationId` in the request. GetComplianceStatusResponseLocationStateEnum: type: string enum: - OPTED_OUT - EXEMPTED - LOCATION_SETUP - ALERTS - NETWORK_ELEMENTS - ROUTING_ENABLE - COMPLIANT description: " * `OPTED_OUT` - Customer has opted out of the E911 service.\n * `EXEMPTED` - RedSky account compliance status has been exempted.\n * `LOCATION_SETUP` - RedSky account is pending location setup.\n * `ALERTS` - RedSky account is pending email notification configuration.\n * `NETWORK_ELEMENTS` - RedSky account is pending network element setup.\n * `ROUTING_ENABLE` - RedSky account is pending the routing enable setup stage.\n * `COMPLIANT` - RedSky account is compliant.\n" ECBNDirectLineEffectiveLevelType: type: string enum: - DIRECT_LINE - LOCATION_ECBN - LOCATION_NUMBER - NONE description: " * `DIRECT_LINE` - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.\n * `LOCATION_ECBN` - Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.\n * `LOCATION_NUMBER` - A location’s main number that is suitable for when the location has a single building with a single floor.\n * `NONE` - There is no effective level type selected.\n" GetComplianceStatusResponseLocationStatusObject: type: object properties: count: type: number example: 2 description: Total count of locations available in the organization. locations: type: array items: $ref: '#/components/schemas/GetComplianceStatusResponseRedSkyClientLocation' description: All the locations available in the organization. CreateBuildingRequest: type: object required: - alertingEmail properties: alertingEmail: type: string example: test@cisco.com description: Email that is used to create alerts in RedSky. At least one email is mandatory. address: $ref: '#/components/schemas/AddressObject' description: Contains address information for the building. UpdateBuildingRequest: type: object properties: address: $ref: '#/components/schemas/AddressObject' description: Contains address information for the building. GetLocationCallingParamtersResponse: type: object properties: integrationEnabled: type: boolean example: true description: Enable to allow RedSky to receive network connectivity information and test calls. routingEnabled: type: boolean example: true description: Enable to route emergency calls to RedSky. GetComplianceStatusResponseRedSkyClientLocation: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA description: Unique identifier for the location. name: type: string example: MainOffice description: Name of the location. state: $ref: '#/components/schemas/GetComplianceStatusResponseLocationStateEnum' description: Configuration stage that was last completed for the specified location. The order of precedence is `LOCATION_SETUP`, `ALERTS`, `NETWORK_ELEMENTS`, `ROUTING_ENABLE`. If at least one location is `LOCATION_SETUP`, then `locationState` will be set to `LOCATION_SETUP`. Otherwise, `locationState` will check for the next precedence option and at least one location should have that option. GetPersonCallbackNumberDependenciesObject: type: object required: - isLocationEcbnDefault - isSelfEcbnDefault - dependentMemberCount properties: isLocationEcbnDefault: type: boolean example: true description: The default emergency callback number for the location when `isLocationEcbnDefault` is true. isSelfEcbnDefault: type: boolean description: The default emergency callback number for the person when `isSelfEcbnDefault` is true. dependentMemberCount: type: number description: Number of members using this person as their emergency callback number. RedSkyComplianceStatusRequestObject: type: object required: - complianceStatus properties: complianceStatus: $ref: '#/components/schemas/ComplianceStatusRequestEnum' description: 'Specifies which stage of the RedSky account creation process has been completed. The stages must be completed in the following order: `LOCATION_SETUP`, `ALERTS`, `NETWORK_ELEMENTS`, `ROUTING_ENABLED`.' LoginResponse: type: object required: - accountMatch - externalTenantEnabled - companyId properties: accountMatch: type: boolean example: true description: '`true` if the old `companyId` secret is matched with the new `companyId` secret.' externalTenantEnabled: type: boolean example: true description: '`true` if the RedSky reseller customer is not under a Cisco account.' companyId: type: string example: ddd1424c-5b48-433d-9bab-061cdfb84c90 description: The RedSky held token from the secret response. ComplianceStatusResponseEnum: type: string enum: - OPTED_OUT - EXEMPTED - NON_COMPLIANT - COMPLIANT description: " * `OPTED_OUT` - Customer has opted out of the E911 service.\n * `EXEMPTED` - RedSky account compliance status has been exempted.\n * `NON_COMPLIANT` - RedSky account is non-compliant.\n * `COMPLIANT` - RedSky account is compliant.\n" RedSkyGetObject: type: object properties: enabled: type: boolean example: true description: '`true` if the service is enabled.' companyId: type: string example: a5e5808f-34ac-4ed0-b8f3-2416bc4cb785 description: The RedSky company ID, which can be retrieved from the RedSky portal. secret: type: string example: '*****' description: The company secret key, which can be found in the RedSky portal. It will be displayed with data masked. locationsEnabled: type: boolean example: true description: '`true` if RedSky is enabled for any location.' CallBackSelectedPatch: type: string enum: - DIRECT_LINE - LOCATION_ECBN - LOCATION_MEMBER_NUMBER description: " * `DIRECT_LINE` - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.\n * `LOCATION_ECBN` - Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.\n * `LOCATION_MEMBER_NUMBER` - Configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.\n" ComplianceStatusResponse: type: object required: - orgStatus - complianceStatus properties: orgStatus: $ref: '#/components/schemas/OrgStatusEnum' description: The RedSky account configuration status for the organization. complianceStatus: $ref: '#/components/schemas/ComplianceStatusResponseEnum' description: The RedSky account's compliance status. companyId: type: string example: ddd1424c-5b48-433d-9bab-061cdfb84c90 description: The RedSky held token from the secret response. redSkyOrgId: type: string example: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 description: The RedSky organization ID for the organization which can be found in the RedSky portal. adminExists: type: boolean example: true description: '`true` if an Admin has been created in RedSky.' locationsStatus: $ref: '#/components/schemas/ComplianceStatusResponseLocationStatusObject' description: Object that contains a list of locations, the `count` for the location list, and the `state` for the location that has completed the least amount of setup. Available if at least one location is exists. RedSkyServiceSettingsObject: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the service is enabled.' companyId: type: string example: a5e5808f-34ac-4ed0-b8f3-2416bc4cb785 description: The RedSky company ID, which can be retrieved from the RedSky portal. secret: type: string example: qwEr4%2d description: The company secret key, which can be found in the RedSky portal. externalTenantEnabled: type: boolean example: true description: '`true` if the RedSky reseller customer is not under a Cisco account.' email: type: string example: test@cisco.com description: The email for the RedSky account. `email` is required if `externalTenantEnabled` is true. password: type: string example: Test@123 description: The password for the RedSky account. `password` is required if `externalTenantEnabled` is true. AddressObject: type: object properties: addressLine1: type: string example: 170 West Tasman Dr description: First line of the building's address. addressLine2: type: string example: Building 6 description: Second line of the building's address. city: type: string example: San Jose description: City for the building's address. stateOrProvince: type: string example: California description: State or Province for the building's address. zipOrPostalCode: type: string example: '95134' description: Zip or Postal Code for the building's address. country: type: string example: US description: Country for the building's address. LoginRequest: type: object required: - email - password properties: email: type: string example: test@cisco.com description: Email for the RedSky account. password: type: string example: Test@123 description: Password for the RedSky account. redSkyOrgId: type: string example: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 description: The RedSky organization ID for the organization which can be found in the RedSky portal. GetLocationCallNotificationObject: type: object properties: emergencyCallNotificationEnabled: type: boolean example: true description: When true sends an email to the specified email address when a call is made from this location to emergency services. emailAddress: type: string example: callback@gmail.com description: When `emergencyCallNotificationEnabled` is true, the emergency notification email is sent to the specified email address. organization: type: object properties: emergencyCallNotificationEnabled: type: boolean example: true description: When true sends an email to the specified email address when a call is made from this location to emergency services. allowEmailNotificationAllLocationEnabled: type: boolean example: true description: Send an emergency call notification email for all locations. emailAddress: type: string example: test@gmail.com description: When `emergencyCallNotificationEnabled` is true, the emergency notification email is sent to the specified email address. description: All locations at organization level PutPersonECBNObject: type: object properties: selected: $ref: '#/components/schemas/CallBackSelectedPatch' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call. locationMemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg description: Member ID of person/workspace/virtual line/hunt group within the location. Required when `selected` is `LOCATION_MEMBER_NUMBER`. elinEnabled: type: boolean example: false description: Indicates whether this person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of their devices. elinForWebexAppEnabled: type: boolean example: false description: Indicates whether this member is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made using Webex App. LocationMemberInfoEffectiveLevelType: type: string enum: - DIRECT_LINE - LOCATION_ECBN - LOCATION_NUMBER - LOCATION_MEMBER_NUMBER - NONE description: " * `DIRECT_LINE` - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.\n * `LOCATION_ECBN` - Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.\n * `LOCATION_NUMBER` - A location’s main number that is suitable for when the location has a single building with a single floor.\n * `LOCATION_MEMBER_NUMBER` - Configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.\n * `NONE` - When no other option is selected.\n" 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" RedSkyCreateObject: type: object required: - email properties: orgPrefix: $ref: '#/components/schemas/orgPrefixObject' description: Represents whether the customer is 'Webex Calling' or not. email: type: string example: test@cisco.com description: The email for the RedSky account administrator. partnerRedskyOrgId: type: string example: 584cf4cd-eea7-4c8c-83ee-67d88fc6eab5 description: New organization is created under this partner organization ID if present, otherwise it will be created under a Cisco partner. ComplianceStatusRequestEnum: type: string enum: - OPTED_OUT - LOCATION_SETUP - ALERTS - NETWORK_ELEMENTS - ROUTING_ENABLED description: " * `OPTED_OUT` - Customer has opted out of the E911 service.\n * `LOCATION_SETUP` - Building and locations stage of the RedSky account creation has been completed.\n * `ALERTS` - Email notification configuration stage of the RedSky account creation has been completed.\n * `NETWORK_ELEMENTS` - Network wire map configuration stage of the RedSky account creation process has been completed and Webex Calling will begin routing emergency test number calls (933) to RedSky.\n * `ROUTING_ENABLED` - Emergency calls for devices in the specified locations will begin to route to RedSky.\n" PutECBNObject: type: object required: - selected properties: selected: $ref: '#/components/schemas/CallBackSelectedPatch' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call. locationMemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg description: Member ID of person/workspace/virtual line/hunt group within the location. Required when `selected` is `LOCATION_MEMBER_NUMBER`. ECBNQualityType: type: string enum: - RECOMMENDED - NOT_RECOMMENDED - INVALID description: " * `RECOMMENDED` - An activated number, associated with a User or Workspace.\n * `NOT_RECOMMENDED` - An activated number, associated with anything else, like Auto Attendant or Hunt Group.\n * `INVALID` - An inactive or non-existent number.\n" PutWorkspaceECBNObject: type: object properties: selected: $ref: '#/components/schemas/CallBackSelectedPatch' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call. locationMemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg description: Member ID of person/workspace/virtual line/hunt group within the location. Required when `selected` is `LOCATION_MEMBER_NUMBER`. elinEnabled: type: boolean example: false description: Indicates whether this workspace is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of its devices. GetHuntGroupCallbackNumberDependenciesObject: type: object required: - isLocationEcbnDefault - isSelfEcbnDefault - dependentMemberCount properties: isLocationEcbnDefault: type: boolean example: true description: The default emergency callback number for the location when `isLocationEcbnDefault` is true. isSelfEcbnDefault: type: boolean description: The default emergency callback number. dependentMemberCount: type: number example: 4 description: Number of members using this hunt group as their emergency callback number. OrgCallNotificationObject: type: object properties: emergencyCallNotificationEnabled: type: boolean example: true description: When true sends an email to the specified email address when a call is made to emergency services. allowEmailNotificationAllLocationEnabled: type: boolean example: true description: Send an emergency call notification email for all locations. emailAddress: type: string example: callback@gmail.com description: When `emergencyCallNotificationEnabled` is true, the emergency notification email is sent to the specified email address. PutLocationCallNotificationObject: type: object properties: emergencyCallNotificationEnabled: type: boolean example: true description: When true sends an email to the specified email address when a call is made from this location to emergency services. emailAddress: type: string example: callback@gmail.com description: Sends an email to this email address when a call is made from this location to emergency services and `emergencyCallNotificationEnabled` is true. VirtualLinesECBNObject: type: object required: - selected properties: selected: $ref: '#/components/schemas/ECBNSelectionType' description: Selected number type to configure emergency call back. directLineInfo: type: object required: - firstName - lastName - effectiveLevel - quality properties: phoneNumber: type: string example: '2056350001' description: The callback phone number that is associated with the direct line. firstName: type: string example: John description: First name of a user. lastName: type: string example: Smith description: Last name of a user. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '9726856770' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the ECBN for this user/location/virtual line/hunt group. locationECBNInfo: type: object required: - effectiveLevel - quality properties: phoneNumber: type: string example: '9726856700' description: The callback phone number that is associated with the location's ECBN configuration. firstName: type: string example: John description: First name for the location. This field will be populated with group name when the `effectiveLevel` is `LOCATION_ECBN` or `LOCATION_NUMBER`. lastName: type: string example: Smith description: This field contains the location member's last name when the `effectiveLevel` is `LOCATION_ECBN`, the location is using a location member number, and the selected member is a user. This field will always return "." when the `effectiveLevel` is `LOCATION_ECBN`, the location is using the location member number, and the selected member is a place. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '9726856770' description: Contains the location-level emergency callback number if valid. If not, contains the user's main number if valid. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the user/place/virtual line/hunt group selected for ECBN for this location. locationMemberInfo: type: object required: - effectiveLevel - quality properties: phoneNumber: type: string example: '9726856700' description: A unique identifier for the location member's PSTN phone number. firstName: type: string example: James description: First name for the location member. lastName: type: string example: Johnson description: Last name for the location member. This field will always return "." when `effectiveLevel` is `DIRECT_LINE` or `LOCATION_MEMBER_NUMBER`, and the selected member is a place. memberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI description: Member ID of user/place/virtual line/hunt group within the location. effectiveLevel: $ref: '#/components/schemas/LocationMemberInfoEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '9726856770' description: Contains the location-level emergency callback number if valid. If not, contains the user's main number if valid. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. memberType: $ref: '#/components/schemas/MemberType' description: Type of the member. defaultInfo: type: object required: - quality properties: effectiveValue: type: string example: '9726856770' description: The field contains ECBN number. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Contains the Emergency Callback Number effective value when none of the above parameters are assigned or some other value is set. OrgStatusEnum: type: string enum: - INITIALISE - ENABLED - OPTED_OUT description: " * `INITIALISE` - RedSky account configuration process is in progress.\n * `ENABLED` - RedSky account configuration process is complete.\n * `OPTED_OUT` - Customer has opted out of the E911 service.\n" VirtualLinesECBNDependenciesObject: type: object required: - isLocationEcbnDefault - isSelfEcbnDefault - dependentMemberCount properties: isLocationEcbnDefault: type: boolean example: true description: '`true` if it is the default emergency callback number for the location.' isSelfEcbnDefault: type: boolean example: true description: Default emergency callback number for the virtual line if `true`. dependentMemberCount: type: number example: 15 description: Number of members using this virtual line as their emergency callback number. ECBNSelectionType: type: string enum: - DIRECT_LINE - LOCATION_ECBN - LOCATION_MEMBER_NUMBER - NONE description: " * `DIRECT_LINE` - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the member's phone is specific to the member’s location.\n * `LOCATION_ECBN` - Each location can have an ECBN configured that is different from the location’s main number. Location Default ECBN is typically configured for users without dedicated telephone numbers or with only an extension.\n * `LOCATION_MEMBER_NUMBER` - Configure one user with another user’s telephone number as an ECBN. This option is used in place of a location’s main number when the location has multiple floors or buildings. This allows the ECBN assigned to have a more accurate Emergency Service Address associated with it.\n * `NONE` - When no other option is selected.\n" UpdateComplianceStatusResponseLocationStateEnum: type: string enum: - LOCATION_SETUP - ALERTS - NETWORK_ELEMENTS - ROUTING_ENABLE description: " * `LOCATION_SETUP` - RedSky account is pending location setup.\n * `ALERTS` - RedSky account is pending email notification configuration.\n * `NETWORK_ELEMENTS` - RedSky account is pending network element setup.\n * `ROUTING_ENABLE` - RedSky account is pending the routing enable setup stage.\n" GetWorkspaceCallbackNumberObject: type: object properties: selected: $ref: '#/components/schemas/ECBNSelectionType' description: Selected number type to configure emergency call back. directLineInfo: type: object required: - firstName - lastName properties: phoneNumber: type: string example: '18164196065' description: The callback phone number that is associated with the direct line. firstName: type: string example: backUpworkspace description: First name of a user. lastName: type: string example: . description: Last name of a user. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196065' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the ECBN for this user/location/virtual line/hunt group. locationECBNInfo: type: object required: - lastName - firstName properties: phoneNumber: type: string example: '18164196065' description: The callback phone number that is associated with the location's ECBN configuration. lastName: type: string example: . description: Last name of the user or location member or `.`. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196065' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. firstName: type: string example: backUpworkspace description: First name of the user or location member or group name. description: Data relevant to the user/place/virtual line/hunt group selected for ECBN for this location. locationMemberInfo: type: object required: - firstName - lastName properties: phoneNumber: type: string example: '18164196065' description: The callback phone number that is associated with member configured for the location ECBN. firstName: type: string example: backUpworkspace description: First name of a user. lastName: type: string example: . description: Last name of the user or location member or `.`. memberId: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8wY2VlYjFmYy04ZmEyLTQ5OGEtYWM3Ni02N2MyZGQ3MGQ2ZGY= description: Member ID of user/place/virtual line/hunt group within the location. effectiveLevel: $ref: '#/components/schemas/LocationMemberInfoEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196065' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. memberType: $ref: '#/components/schemas/MemberType' description: Type of the member. description: Data relevant to the user/place/virtual line/hunt group selected for ECBN. defaultInfo: type: object properties: effectiveValue: type: string example: '18164196068' description: The field contains the ECBN number. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene. elinEnabled: type: boolean example: false description: Indicates whether this workspace is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of its devices. GetComplianceStatusResponse: type: object required: - orgStatus - complianceStatus properties: orgStatus: $ref: '#/components/schemas/OrgStatusEnum' description: The RedSky account configuration status for the organization. complianceStatus: $ref: '#/components/schemas/ComplianceStatusResponseEnum' description: The RedSky account's compliance status. companyId: type: string example: ddd1424c-5b48-433d-9bab-061cdfb84c90 description: The RedSky held token from the secret response. redSkyOrgId: type: string example: 2ff43e05-af11-41ff-91b6-87a3b509f4z4 description: The RedSky organization ID for the organization which can be found in the RedSky portal. adminExists: type: boolean example: true description: '`true` if an Admin has been created in RedSky.' locationsStatus: $ref: '#/components/schemas/GetComplianceStatusResponseLocationStatusObject' description: Object that contains a list of locations and the `count` for the location list. Available if at least one location is exists. GetPersonCallbackNumberObject: type: object properties: selected: $ref: '#/components/schemas/ECBNSelectionType' description: Selected number type to configure emergency callback. directLineInfo: type: object required: - firstName - lastName properties: phoneNumber: type: string example: '18164196065' description: The callback phone number that is associated with the direct line. firstName: type: string example: User1 description: First name of the user. lastName: type: string example: User1LastName description: Last name of the user. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196065' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the ECBN for this user/location/virtual line/hunt group. locationECBNInfo: type: object required: - firstName - lastName properties: firstName: type: string example: group1 description: First name of the user or location member or group name. lastName: type: string example: . description: Last name of the user or location member or `.`. phoneNumber: type: string example: '18164196066' description: The callback phone number that is associated with the location's ECBN configuration. effectiveLevel: $ref: '#/components/schemas/ECBNDirectLineEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196066' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the ECBN for this user/location/virtual line/hunt group. locationMemberInfo: type: object required: - firstName - lastName properties: phoneNumber: type: string example: '18164196067' description: The callback phone number that is associated with member configured for the location ECBN. firstName: type: string example: workspace1 description: First name of the user. lastName: type: string example: . description: Last name of the user or `.`. memberId: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzExYTNmOTkwLWE2ODktNDc3ZC1iZTZiLTcxMjAwMjVkOGFiYg description: Member ID of user/place/virtual line/hunt group within the location memberType: $ref: '#/components/schemas/MemberType' description: Type of the member. effectiveLevel: $ref: '#/components/schemas/LocationMemberInfoEffectiveLevelType' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '18164196067' description: The field contains the valid ECBN number at the location level, or the user's main number if valid, defaulting to the location's main number if both are unavailable. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the ECBN for this user/location/virtual line/hunt group. defaultInfo: type: object properties: effectiveValue: type: string example: '18164196068' description: The field contains the ECBN number. quality: $ref: '#/components/schemas/ECBNQualityType' description: Used to represent whether a number is a recommended ECBN. description: Gives Emergency Callback Number effective value when none of the above is assigned or some other value is set behind the scene. elinEnabled: type: boolean example: false description: Indicates whether this person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made from one of their devices. elinForWebexAppEnabled: type: boolean example: false description: Indicates whether this person is allowed to use an Emergency Location Identification Number (ELIN) for emergency calls made using Webex App. ComplianceStatusResponseLocationStatusObject: type: object properties: state: $ref: '#/components/schemas/UpdateComplianceStatusResponseLocationStateEnum' description: Configuration stage that was last completed. The order of precedence is `LOCATION_SETUP`, `ALERTS`, `NETWORK_ELEMENTS`, `ROUTING_ENABLE`. If at least one location is `LOCATION_SETUP`, then `locationState` will be set to `LOCATION_SETUP`. Otherwise, `locationState` will check for the next precedence option and at least one location should have that option. count: type: number example: 2 description: Total count of locations available in the organization. locations: type: array items: $ref: '#/components/schemas/ComplianceStatusResponseRedSkyClientLocation' description: List of locations that have completed the least amount of setup. Only 4 locations are included in this list. UpdateLocationComplianceStatusResponse: type: object properties: locationsStatus: $ref: '#/components/schemas/ComplianceStatusLocationStatusObject' description: Contains RedSky account configuration status for the locations in the organization. GetWorkspaceCallbackNumberDependenciesObject: type: object required: - isLocationEcbnDefault - isSelfEcbnDefault - dependentMemberCount properties: isLocationEcbnDefault: type: boolean example: true description: When `isLocationEcbnDefault` is true, then it is the default emergency callback number for the location. isSelfEcbnDefault: type: boolean description: Default emergency callback number of the place if `true`. dependentMemberCount: type: number description: Number of members using this workspace as their emergency callback number. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps