wxc_sdk.telephony.emergency_services package
- class wxc_sdk.telephony.emergency_services.OrgEmergencyServicesApi(*, session: RestSession, base: str | None = None)[source]
Bases:
ApiChildOrganization 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.
- read_emergency_call_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:
- update_emergency_call_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
- base = 'telephony/config/emergencyCallNotification'
- 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.