PUT - Group Emergency Zones

Updates the Emergency Zone configuration in the group.

Parameters

  • service_provider_id (str): Service provider ID where the Emergency Zone to be updated exists.

  • group_id (str): Group ID where the Emergency Zone to be updated exists.

  • is_active (bool, optional): Whether the Emergency Zone service is active or not. Defaults to True

  • zone_rules (str, optional): The rules of the Emergency Zone. This will either be "Prohibit all registrations and call originations" or "Prohibit emergency call originations".

  • emergency_notification_email (str, optional): The email address where emergency call notifications should be sent.

  • ip_addresses (list, optional): A list of IP address ranges (dicts) to be added to the Emergency Zone. If the IP address to be applied is not a range, the min and max values should be the same.

Returns

  • Dict: Updated Emergency Zone configuration.

How To Use:

my_api.emergency_zones.put_group_emergency_zones(
    service_provider_id = "my_service_proviider_id", 
    group_id = "my_group_id", 
    zone_rules = "Prohibit emergency call originations", 
    emergency_notification_email = "[email protected]",
    ip_addresses = [
        {
            "min": "123.45.0.67",
            "max": "123.45.0.68"
        }, 
        {
            "min": "11.0.0.0",
            "max": "11.0.0.0"
        }
    ]
)

Example Data Returned (Formatted)

{
    "isActive": "True", 
    "emergencyZonesProhibition": "Prohibit emergency call originations", 
    "sendEmergencyCallNotifyEmail": "True", 
    "emergencyCallNotifyEmailAddress": "[email protected]", 
    "serviceProviderId": "my_service_provider_id", 
    "groupId": "my_group_id", 
    "ipAddresses": [
        {
            "min": "11.0.0.0", 
            "max": "11.0.0.0"
        },
        {
            "min": "123.45.0.67", 
            "max": "123.45.0.68"
        }
    ]
}

Last updated

Was this helpful?