wxc_sdk.telephony.location.emergency_services package

class wxc_sdk.telephony.location.emergency_services.LocationEmergencyServicesApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

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.

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.

read_emergency_call_notification(location_id: str, org_id: str | None = None) → LocationEmergencyCallNotification

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:

LocationEmergencyCallNotification

update_emergency_call_notification(location_id: str, setting: LocationEmergencyCallNotification, org_id: str | None = None)

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.

• setting (LocationEmergencyCallNotification) – new settings

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

Return type:

None

base = 'telephony/config/locations'

class wxc_sdk.telephony.location.emergency_services.LocationEmergencyCallNotification(*, emergencyCallNotificationEnabled: bool | None = None, emailAddress: str | None = None, organization: LocationCallNotificationOrganization | None = None, **extra_data: Any)

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

All locations at organization level

class wxc_sdk.telephony.location.emergency_services.LocationCallNotificationOrganization(*, emergencyCallNotificationEnabled: bool | None = None, allowEmailNotificationAllLocationEnabled: bool | None = None, emailAddress: str | None = None, **extra_data: Any)

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.

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.