wxc_sdk.telephony.emergency_services package

class wxc_sdk.telephony.emergency_services.OrgEmergencyServicesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Organization Call Settings with Emergency Services

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.

Viewing these organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read. Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

get_notification(org_id: str | None = None) → OrgEmergencyCallNotification[source]

Get an Organization Emergency Call Notification

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.

Parameters:

org_id (str) – Retrieve Emergency Call Notification attributes for the organization.

Return type:

OrgEmergencyCallNotification

update_notification(setting: OrgEmergencyCallNotification, org_id: str | None = None)[source]

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.

Parameters:

  • setting (OrgEmergencyCallNotification) – updated settings

  • org_id (str) – Update Emergency Call Notification attributes for the organization.

Return type:

None

hunt_group_ecbn_dependencies(hunt_group_id: str, org_id: str | None = None) → ECBNDependencies[source]

Get Dependencies for a Hunt Group Emergency Callback Number

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.

Parameters:

  • hunt_group_id (str) – Unique identifier for the hunt group.

  • org_id (str) – Retrieve Emergency Callback Number attributes for the hunt group under this organization.

Return type:

ECBNDependencies

get_location_notification(location_id: str, org_id: str | None = None) → LocationCallNotification[source]

Get a Location Emergency Call Notification

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.

Parameters:

  • location_id (str) – Retrieve Emergency Call Notification attributes for this location.

  • org_id (str) – Retrieve Emergency Call Notification attributes for the location in this organization.

Return type:

LocationCallNotification

update_location_notification(location_id: str, emergency_call_notification_enabled: bool | None = None, email_address: str | None = None, org_id: str | None = None)[source]

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.

Parameters:

  • location_id (str) – Update Emergency Call Notification attributes for this location.

  • emergency_call_notification_enabled (bool) – When true sends an email to the specified email address when a call is made from this location to emergency services.

  • email_address (str) – Sends an email to this email address when a call is made from this location to emergency services and emergencyCallNotificationEnabled is true.

  • org_id (str) – Update Emergency Call Notification attributes for a location in this organization.

Return type:

None

get_location_parameters(location_id: str, org_id: str | None = None) → RedSkyLocationParameters[source]

Get a Location’s RedSky Emergency Calling Parameters

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.

Parameters:

  • location_id (str) – Retrieve Calling Parameters for this location.

  • org_id (str) – Retrieve Calling Parameters for the location in this organization.

Return type:

RedSkyLocationParameters

create_location_address_and_alert_email(location_id: str, alerting_email: str, address: RedSkyAddress | None = None, org_id: str | None = None)[source]

Create a RedSky Building Address and Alert Email for a Location

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.

Parameters:

  • location_id (str) – Create the building address and alert email for this location.

  • alerting_email (str) – Email that is used to create alerts in RedSky. At least one email is mandatory.

  • address (RedSkyAddress) – Contains address information for the building.

  • org_id (str) – The organization in which the location exists.

Return type:

None

update_location_address(location_id: str, address: RedSkyAddress | None = None, org_id: str | None = None)[source]

Update a RedSky Building Address for a Location

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.

Parameters:

  • location_id (str) – Update the building address for this location.

  • address (RedSkyAddress) – Contains address information for the building.

  • org_id (str) – The organization in which the location exists.

Return type:

None

get_location_compliance_status(location_id: str, org_id: str | None = None) → RedSkyComplianceStatus[source]

Get a Location’s RedSky Compliance Status

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.

Parameters:

  • location_id (str) – Retrieve the compliance status for this location.

  • org_id (str) – Retrieve compliance status for the location in this organization.

Return type:

RedSkyComplianceStatus

update_location_compliance_status(location_id: str, compliance_status: RedSkyLocationState, org_id: str | None = None) → ComplianceLocationStatus[source]

Update a Location’s RedSky Compliance Status

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.

Parameters:

  • location_id (str) – Update the E911 compliance status for this location.

  • compliance_status (RedSkyLocationState) – 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.

  • org_id (str) – Update the E911 compliance status for the location in this organization.

Return type:

ComplianceLocationStatus

get_redsky_account_details(org_id: str | None = None) → RedSkyAccount[source]

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.

Parameters:

org_id (str) – Retrieve RedSky account for the organization.

Return type:

RedSkyAccount

create_redsky_account_and_admin(email: str, org_prefix: OrgPrefixObject | None = None, partner_redsky_org_id: str | None = None, org_id: str | None = None)[source]

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.

Parameters:

  • email (str) – The email for the RedSky account administrator.

  • org_prefix (OrgPrefixObject) – Represents whether the customer is ‘Webex Calling’ or not.

  • partner_redsky_org_id (str) – New organization is created under this partner organization ID if present, otherwise it will be created under a Cisco partner.

  • org_id (str) – Create RedSky account for the organization.

Return type:

None

login(email: str, password: str, red_sky_org_id: str | None = None, org_id: str | None = None) → LoginResponse[source]

Login to a RedSky Admin Account

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.

Parameters:

  • email (str) – Email for the RedSky account.

  • password (str) – Password for the RedSky account.

  • red_sky_org_id (str) – The RedSky organization ID for the organization which can be found in the RedSky portal.

  • org_id (str) – Login to a RedSky account for the organization.

Return type:

LoginResponse

get_org_compliance(start: int | None = None, max_: int | None = None, order: str | None = None, org_id: str | None = None) → RedSkyComplianceStatus[source]

Get the Organization Compliance Status and the Location Status List

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.

Parameters:

  • start (int) – Specifies the offset from the first result that you want to fetch.

  • max (int) – Specifies the maximum number of records that you want to fetch.

  • order (str) – 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.

  • org_id (str) – Retrieve the compliance status and the list of location statuses for the organization.

Return type:

RedSkyComplianceStatus

update_service_settings(enabled: bool, company_id: str | None = None, secret: str | None = None, external_tenant_enabled: bool | None = None, email: str | None = None, password: str | None = None, org_id: str | None = None)[source]

Update RedSky Service Settings

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.

Parameters:

  • enabled (bool) – true if the service is enabled.

  • company_id (str) – The RedSky company ID, which can be retrieved from the RedSky portal.

  • secret (str) – The company secret key, which can be found in the RedSky portal.

  • external_tenant_enabled (bool) – true if the RedSky reseller customer is not under a Cisco account.

  • email (str) – The email for the RedSky account. email is required if externalTenantEnabled is true.

  • password (str) – The password for the RedSky account. password is required if externalTenantEnabled is true.

  • org_id (str) – Update E911 settings for the organization.

Return type:

None

get_org_compliance_status(org_id: str | None = None) → RedSkyComplianceStatus[source]

Get the Organization Compliance Status for a RedSky Account

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.

Parameters:

org_id (str) – Retrieve the compliance status for the organization.

Return type:

RedSkyComplianceStatus

update_org_compliance_status(compliance_status: RedSkyLocationState, org_id: str | None = None) → RedSkyComplianceStatus[source]

Update the Organization RedSky Account’s Compliance Status

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.

Parameters:

  • compliance_status (RedSkyLocationState) – 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.

  • org_id (str) – Update E911 compliance status for the organization.

Return type:

RedSkyComplianceStatus

base = 'telephony/config'
class wxc_sdk.telephony.emergency_services.OrgEmergencyCallNotification(*, emergencyCallNotificationEnabled: bool | None = None, allowEmailNotificationAllLocationEnabled: bool | None = None, emailAddress: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

emergency_call_notification_enabled: bool | None

When true sends an email to the specified email address when a call is made to emergency services.

allow_email_notification_all_location_enabled: bool | None

Send an emergency call notification email for all locations.

email_address: str | None

When emergencyCallNotificationEnabled is true, the emergency notification email is sent to the specified email address.

class wxc_sdk.telephony.emergency_services.OrgPrefixObject(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

wxc = 'wxc'

The customer is Webex calling.

wxc_whs = 'wxc-whs'

The customer is a wholesale.

class wxc_sdk.telephony.emergency_services.RedSkyAccount(*, enabled: bool | None = None, companyId: str | None = None, secret: str | None = None, locationsEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

true if the service is enabled.

company_id: str | None

The RedSky company ID, which can be retrieved from the RedSky portal.

secret: str | None

The company secret key, which can be found in the RedSky portal. It will be displayed with data masked.

locations_enabled: bool | None

true if RedSky is enabled for any location.

class wxc_sdk.telephony.emergency_services.ComplianceStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

opted_out = 'OPTED_OUT'

Customer has opted out of the E911 service.

exempted = 'EXEMPTED'

RedSky account compliance status has been exempted.

non_compliant = 'NON_COMPLIANT'

RedSky account is non-compliant.

compliant = 'COMPLIANT'

RedSky account is compliant.

class wxc_sdk.telephony.emergency_services.LoginResponse(*, accountMatch: bool | None = None, externalTenantEnabled: bool | None = None, companyId: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

account_match: bool | None

true if the old companyId secret is matched with the new companyId secret.

external_tenant_enabled: bool | None

true if the RedSky reseller customer is not under a Cisco account.

company_id: str | None

The RedSky held token from the secret response.

class wxc_sdk.telephony.emergency_services.LocationCallNotification(*, emergencyCallNotificationEnabled: bool | None = None, emailAddress: str | None = None, organization: OrgEmergencyCallNotification | None = None, **extra_data: Any)[source]

Bases: ApiModel

emergency_call_notification_enabled: bool | None

When true sends an email to the specified email address when a call is made from this location to emergency services.

email_address: str | None

When emergencyCallNotificationEnabled is true, the emergency notification email is sent to the specified email address.

organization: OrgEmergencyCallNotification | None

All locations at organization level

class wxc_sdk.telephony.emergency_services.RedSkyOrgStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

initialise = 'INITIALISE'

RedSky account configuration process is in progress.

enabled = 'ENABLED'

RedSky account configuration process is complete.

opted_out = 'OPTED_OUT'

Customer has opted out of the E911 service.

class wxc_sdk.telephony.emergency_services.RedSkyComplianceStatus(*, orgStatus: RedSkyOrgStatus | None = None, complianceStatus: ComplianceStatus | None = None, companyId: str | None = None, redSkyOrgId: str | None = None, adminExists: bool | None = None, locationsStatus: ComplianceLocationStatus | None = None, **extra_data: Any)[source]

Bases: ApiModel

org_status: RedSkyOrgStatus | None

The RedSky account configuration status for the organization.

compliance_status: ComplianceStatus | None

The RedSky account’s compliance status.

company_id: str | None

The RedSky held token from the secret response.

red_sky_org_id: str | None

The RedSky organization ID for the organization which can be found in the RedSky portal.

admin_exists: bool | None

true if an Admin has been created in RedSky.

locations_status: ComplianceLocationStatus | None

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.

class wxc_sdk.telephony.emergency_services.ComplianceLocationStatus(*, state: RedSkyLocationState | None = None, count: int | None = None, locations: list[RedSkyClientLocation] | None = None, **extra_data: Any)[source]

Bases: ApiModel

state: RedSkyLocationState | None

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: int | None

Total count of locations available in the organization.

locations: list[RedSkyClientLocation] | None

All the locations available in the organization.

class wxc_sdk.telephony.emergency_services.RedSkyLocationParameters(*, integrationEnabled: bool | None = None, routingEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

integration_enabled: bool | None

Enable to allow RedSky to receive network connectivity information and test calls.

routing_enabled: bool | None

Enable to route emergency calls to RedSky.

class wxc_sdk.telephony.emergency_services.RedSkyLocationState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

opted_out = 'OPTED_OUT'

Customer has opted out of the E911 service.

exempted = 'EXEMPTED'

RedSky account compliance status has been exempted.

location_setup = 'LOCATION_SETUP'

RedSky account is pending location setup.

alerts = 'ALERTS'

RedSky account is pending email notification configuration.

network_elements = 'NETWORK_ELEMENTS'

RedSky account is pending network element setup.

routing_enable = 'ROUTING_ENABLE'

RedSky account is pending the routing enable setup stage.

compliant = 'COMPLIANT'

RedSky account is compliant.

class wxc_sdk.telephony.emergency_services.RedSkyClientLocation(*, id: str | None = None, name: str | None = None, state: RedSkyLocationState | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier for the location.

name: str | None

Name of the location.

state: RedSkyLocationState | None

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.

class wxc_sdk.telephony.emergency_services.RedSkyAddress(*, addressLine1: str | None = None, addressLine2: str | None = None, city: str | None = None, stateOrProvince: str | None = None, zipOrPostalCode: str | None = None, country: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

address_line1: str | None

First line of the building’s address.

address_line2: str | None

Second line of the building’s address.

city: str | None

City for the building’s address.

state_or_province: str | None

State or Province for the building’s address.

zip_or_postal_code: str | None

Zip or Postal Code for the building’s address.

country: str | None

Country for the building’s address.