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