ALalianza
Emergency Notification

Retrieve notification event list

Use to retrieve all Emergency Notification Events for an account. For accounts with Emergency Notification enabled, one of these is automatically generated anytime any enduser of the account places a 911 or 933 call.

get/v2/partition/{partitionId}/account/{accountId}/emergency-notifications/events

Request

Path parameters

accountIdstring required

ID of account. Refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition. Refers to <a href="#/~schema/Account">account.partitionId</a>, which refers to <a href="#/~schema/PartitionX">partition.id</a>

Response

Successful operation

idstring uuid

The unique identifier of the event, auto generated by the system.

callTimestring date-time

The time the emergency call was placed. ISO 8601 format.

timeZoneIdstring

The time zone from which the call was placed.

groupIdstring

The id of the group that was notified. What this points to depends on the groupType field. If groupType is ACCOUNT, this refers to <a href="#/~schema/Account">account.id</a>.

groupType'ACCOUNT'
triggerType'EMERGENCY_CALL' | 'EMERGENCY_TEST_CALL' | 'NOTIFICATION_TEST'

The type of event that triggered the notification.

triggeringPhoneNumberstring

The phone number from which the 911 call was made. Will be null for events with triggerType of NOTIFICATION_TEST.

status'SENT' | 'FAILED' | 'PARTIAL'

Indicates the success of the notification delivery.<BR>SENT - notification successfully sent to all intended recipients.<BR>FAILED - notification failed to be sent to any intended recipients.<BR>PARTIAL - notification was sent to some, but not all, intended recipients.

Changes

No recorded changes to this operation across all 1 revision of this API.