Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Webex

Webex Emergency Services Settings API

The Emergency Services Settings API from Webex — 17 operation(s) for emergency services settings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Webex Emergency Services Settings API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Emergency Services Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 26 operations across 17 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

26 operations 17 paths 44 schemas 14 GET3 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Emergency Services Settings API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 26

Across 17 paths, the API surfaces 26 operations — 14 GET, 3 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Emergency Services Settings 26
PUT
/telephony/config/redSky/serviceSettings
Update RedSky Service Settings
Update RedSky Service Settings 1 param body → 204400401403404405409410
POST
/telephony/config/redSky
Create an Account and Admin in RedSky
Create an Account and Admin in RedSky 1 param body → 201400401403404405409410
GET
/telephony/config/redSky
Retrieve RedSky Account Details for an Organization
Retrieve RedSky Account Details for an Organization 1 param → 200400401403404405409410
PUT
/telephony/config/redSky/status
Update the Organization RedSky Account's Compliance Status
Update the Organization RedSky Account's Compliance Status 1 param body → 200400401403404405409410
GET
/telephony/config/redSky/status
Get the Organization Compliance Status for a RedSky Account
Get the Organization Compliance Status for a RedSky Account 1 param → 200400401403404405409410
GET
/telephony/config/redSky/complianceStatus
Get the Organization Compliance Status and the Location Status List
Get the Organization Compliance Status and the Location Status List 4 params → 200400401403404405409410
POST
/telephony/config/redSky/actions/login/invoke
Login to a RedSky Admin Account
Login to a RedSky Admin Account 1 param body → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/redSky
Get a Location's RedSky Emergency Calling Parameters
Get a Location's RedSky Emergency Calling Parameters 2 params → 200400401403404405409410
GET
/telephony/config/locations/{locationId}/redSky/status
Get a Location's RedSky Compliance Status
Get a Location's RedSky Compliance Status 2 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/redSky/status
Update a Location's RedSky Compliance Status
Update a Location's RedSky Compliance Status 2 params body → 200400401403404405409410
POST
/telephony/config/locations/{locationId}/redSky/building
Create a RedSky Building Address and Alert Email for a Location
Create a RedSky Building Address and Alert Email for a Location 2 params body → 201400401403404405409410
PUT
/telephony/config/locations/{locationId}/redSky/building
Update a RedSky Building Address for a Location
Update a RedSky Building Address for a Location 2 params body → 204400401403404405409410
GET
/telephony/config/emergencyCallNotification
Get an Organization Emergency Call Notification
Get an Organization Emergency Call Notification 1 param → 200400401403404405409410
PUT
/telephony/config/emergencyCallNotification
Update an Organization Emergency Call Notification
Update an Organization Emergency Call Notification 1 param body → 204400401403404405409410
GET
/telephony/config/locations/{locationId}/emergencyCallNotification
Get a Location Emergency Call Notification
Get a Location Emergency Call Notification 2 params → 200400401403404405409410
PUT
/telephony/config/locations/{locationId}/emergencyCallNotification
Update a Location Emergency Call Notification
Update a Location Emergency Call Notification 2 params body → 204400401403404405409410
GET
/telephony/config/huntGroups/{huntGroupId}/emergencyCallbackNumber/dependencies
Get Dependencies for a Hunt Group Emergency Callback Number
Get Dependencies for a Hunt Group Emergency Callback Number 2 params → 200400401403404405409410
GET
/telephony/config/people/{personId}/emergencyCallbackNumber
Get a Person's Emergency Callback Number
Get a Person's Emergency Callback Number 2 params → 200400401403404405409410
PUT
/telephony/config/people/{personId}/emergencyCallbackNumber
Update a Person's Emergency Callback Number
Update a Person's Emergency Callback Number 2 params body → 204400401403404405409410
GET
/telephony/config/people/{personId}/emergencyCallbackNumber/dependencies
Retrieve A Person's Emergency Callback Number Dependencies
Retrieve A Person's Emergency Callback Number Dependencies 2 params → 200400401403404405409410
GET
/telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber
Get a Workspace Emergency Callback Number
Get a Workspace Emergency Callback Number 2 params → 200400401403404405409410
PUT
/telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber
Update a Workspace Emergency Callback Number
Update a Workspace Emergency Callback Number 2 params body → 204400401403404405409410
GET
/telephony/config/workspaces/{workspaceId}/emergencyCallbackNumber/dependencies
Retrieve Workspace Emergency Callback Number Dependencies
Retrieve Workspace Emergency Callback Number Dependencies 2 params → 200400401403404405409410
GET
/telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber/dependencies
Get Dependencies for a Virtual Line Emergency Callback Number
Get Dependencies for a Virtual Line Emergency Callback Number 2 params → 200400401403404405409410
GET
/telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber
Get the Virtual Line's Emergency Callback settings
Get the Virtual Line's Emergency Callback settings 2 params → 200400401403404405409410
PUT
/telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber
Update a Virtual Line's Emergency Callback settings
Update a Virtual Line's Emergency Callback settings 2 params body → 204400401403404405409410

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are GetPersonCallbackNumberObject (7 properties), GetLocationComplianceStatusResponse (6 properties), ComplianceStatusResponse (6 properties), RedSkyServiceSettingsObject (6 properties). Each schema is shown below with its type and property counts.

ComplianceStatusLocationStatusObject
object
3 properties
ComplianceStatusResponseRedSkyClientLocation
object
2 properties 2 required
orgPrefixObject
string
wxc - The customer is Webex calling. wxc-whs - The customer is a wholesale.
GetLocationComplianceStatusResponse
object
6 properties 2 required
GetComplianceStatusResponseLocationStateEnum
string
OPTEDOUT - Customer has opted out of the E911 service. EXEMPTED - RedSky account compliance status has been exempted. LOCATIONSETUP - RedSky account is pending…
ECBNDirectLineEffectiveLevelType
string
DIRECTLINE - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the membe…
GetComplianceStatusResponseLocationStatusObject
object
2 properties
CreateBuildingRequest
object
2 properties 1 required
UpdateBuildingRequest
object
1 property
GetLocationCallingParamtersResponse
object
2 properties
GetComplianceStatusResponseRedSkyClientLocation
object
3 properties 2 required
GetPersonCallbackNumberDependenciesObject
object
3 properties 3 required
RedSkyComplianceStatusRequestObject
object
1 property 1 required
LoginResponse
object
3 properties 3 required
ComplianceStatusResponseEnum
string
OPTEDOUT - Customer has opted out of the E911 service. EXEMPTED - RedSky account compliance status has been exempted. NONCOMPLIANT - RedSky account is non-comp…
RedSkyGetObject
object
4 properties
CallBackSelectedPatch
string
DIRECTLINE - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the membe…
ComplianceStatusResponse
object
6 properties 2 required
RedSkyServiceSettingsObject
object
6 properties 1 required
AddressObject
object
6 properties
LoginRequest
object
3 properties 2 required
GetLocationCallNotificationObject
object
3 properties
PutPersonECBNObject
object
4 properties
LocationMemberInfoEffectiveLevelType
string
DIRECTLINE - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the membe…
MemberType
string
PEOPLE - Indicates the associated member is a person. PLACE - Indicates the associated member is a workspace.
RedSkyCreateObject
object
3 properties 1 required
ComplianceStatusRequestEnum
string
OPTEDOUT - Customer has opted out of the E911 service. LOCATIONSETUP - Building and locations stage of the RedSky account creation has been completed. ALERTS -…
PutECBNObject
object
2 properties 1 required
ECBNQualityType
string
RECOMMENDED - An activated number, associated with a User or Workspace. NOTRECOMMENDED - An activated number, associated with anything else, like Auto Attendan…
PutWorkspaceECBNObject
object
3 properties
GetHuntGroupCallbackNumberDependenciesObject
object
3 properties 3 required
OrgCallNotificationObject
object
3 properties
PutLocationCallNotificationObject
object
2 properties
VirtualLinesECBNObject
object
5 properties 1 required
OrgStatusEnum
string
INITIALISE - RedSky account configuration process is in progress. ENABLED - RedSky account configuration process is complete. OPTEDOUT - Customer has opted out…
VirtualLinesECBNDependenciesObject
object
3 properties 3 required
ECBNSelectionType
string
DIRECTLINE - Returned calls from the Public Safety Answering Point go directly to the member. The Emergency Service Address configured by the PSTN to the membe…
UpdateComplianceStatusResponseLocationStateEnum
string
LOCATIONSETUP - RedSky account is pending location setup. ALERTS - RedSky account is pending email notification configuration. NETWORKELEMENTS - RedSky account…
GetWorkspaceCallbackNumberObject
object
6 properties
GetComplianceStatusResponse
object
6 properties 2 required
GetPersonCallbackNumberObject
object
7 properties
ComplianceStatusResponseLocationStatusObject
object
3 properties
UpdateLocationComplianceStatusResponse
object
1 property
GetWorkspaceCallbackNumberDependenciesObject
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-emergency-services-settings-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
AE Profile APIs.io
Webex Admin Audit Events API
AE Profile APIs.io
Webex Agent Personal Greeting Files API
AE Profile APIs.io
Webex Agent Summaries API
AE Profile APIs.io
Webex Agent Wellbeing API
AE Profile APIs.io
Webex Agents API
AE Profile APIs.io
Webex AI Feature API
AE Profile APIs.io
Webex API - Domain Management API
AE Profile APIs.io
Webex Archive Users API
AE Profile APIs.io
Webex Attachment Actions API
AE Profile APIs.io
Webex Audio Files API
AE Profile APIs.io
Webex Authorizations API
AE Profile APIs.io
#Emergency Services Settings
← Back to W APIs
API Details
ID
webex:webex-emergency-services-settings-api
Docs
https://developer.webex.com/docs/messaging
Provider
Webex
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network