Sending Bulk Alerts
1. Retrieve the default Alert Settings for the authorized Sender
POST - /api/v2/alerts/defaults
{
"alertType": "Default"
}
{
"item": {
"fields": [
{
"name": "incident-v2",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "message",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"invisible": false,
"readonly": false,
"systemRequired": true,
"autofill": false
}
],
"alertType": "Default",
"channels": {
"email": {
"requestConfirmation": false,
"send": true
},
"push": {
"send": true
}
},
"clientContext": {
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
},
"formType": "Quick",
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"subject": "Alert",
"message": ""
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"uniqueMyAlertsAppCount": 0,
"uniqueEtnCount": 0,
"uniqueGroupCount": 0,
"uniqueContactCount": 0,
"selectedContactCount": 0,
"selectedGroupCount": 0,
"groupIds": [],
"mandatoryGroupIds": [],
"contactIds": [],
"groups": [],
"contacts": [],
"directories": [],
"searchFilters": []
},
"schedule": {
"scheduled": false,
"duration": 1440,
"type": "Hickory"
},
"sender": {
"id": 0,
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com",
"callerId": "8334193463"
},
"hidden": false,
"weatherAlert": false,
"requestConfirmation": false,
"relatedAlertActions": {
"disableReplyAll": false
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
2. Send Bulk Alerts
Note
The default alert settings should be used as the base for composing SendAlertRequests. It is recommended to clone the default alert settings for each alert included in the BulkSendAlertRequest.
Example of cloning the alert defaults (.NET C#)
var facilities = new List<string> { "AAR1", "ABE2", "ABE3", "ABE4", "ABE40", "ABE5", "ABE8", "ABQ1", "ABQ2", "ABQ5" };
// GUID to identify alerts sent by this test
var testId = Guid.NewGuid().ToString();
var alerts = new List<SendAlertRequest>();
foreach (var facility in facilities)
{
// Clone defaults, so each alert request is unique
var defaults = alertDefaults.Clone();
var messageId = Guid.NewGuid().ToString();
defaults.Message.Basic.Subject = $"Bulk Test message {testId} - {messageId}";
defaults.Message.Basic.Message = $"This is a test message from - {testId} - {messageId}";
defaults.Message.Priority = PriorityType.Emergency;
defaults.Recipients.SearchFilters = new List<AccessRecipe> { BuildAccessRecipe(facility) };
alerts.Add(new SendAlertRequest(defaults, 0, null, messageId, true));
}
POST - /api/v4/9331/alerts/bulkSend
{
"tenantId": 9331,
"alerts": [
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - f9a9d09d-3ec7-4379-88a1-bf77b7d5b6dc",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - f9a9d09d-3ec7-4379-88a1-bf77b7d5b6dc"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"AAR1"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "f9a9d09d-3ec7-4379-88a1-bf77b7d5b6dc",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 4bc36c98-e60a-4e00-a373-3d94d38c69ab",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 4bc36c98-e60a-4e00-a373-3d94d38c69ab"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE2"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "4bc36c98-e60a-4e00-a373-3d94d38c69ab",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 0715ec9f-99df-4264-98a5-d76f3d902f9e",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 0715ec9f-99df-4264-98a5-d76f3d902f9e"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE3"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "0715ec9f-99df-4264-98a5-d76f3d902f9e",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - b307d3f7-6823-4ab1-b007-58ca51a43e66",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - b307d3f7-6823-4ab1-b007-58ca51a43e66"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE4"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "b307d3f7-6823-4ab1-b007-58ca51a43e66",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - c350a634-f9b3-4960-826e-48e306c7025f",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - c350a634-f9b3-4960-826e-48e306c7025f"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE40"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "c350a634-f9b3-4960-826e-48e306c7025f",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 95f7ab1b-1be4-4cc8-b9ee-5ac365557bc7",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 95f7ab1b-1be4-4cc8-b9ee-5ac365557bc7"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE5"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "95f7ab1b-1be4-4cc8-b9ee-5ac365557bc7",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 524fdf1f-ac73-48f1-9ab8-ce7bdf9ebbb9",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 524fdf1f-ac73-48f1-9ab8-ce7bdf9ebbb9"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABE8"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "524fdf1f-ac73-48f1-9ab8-ce7bdf9ebbb9",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - f1b095f8-73f1-4b97-a405-5ec1c36738a6",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - f1b095f8-73f1-4b97-a405-5ec1c36738a6"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABQ1"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "f1b095f8-73f1-4b97-a405-5ec1c36738a6",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 4ab7f3cc-9061-44eb-9284-7dbdd69ef632",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 4ab7f3cc-9061-44eb-9284-7dbdd69ef632"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABQ2"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "4ab7f3cc-9061-44eb-9284-7dbdd69ef632",
"async": true
},
{
"settings": {
"fields": [
{
"name": "incident-v2",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "advancedSiteSelection",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "recipients",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "surveyRecipient",
"required": false,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "subject",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "message",
"required": true,
"systemRequired": false,
"invisible": false,
"readonly": false,
"autofill": false
},
{
"name": "channels",
"required": true,
"systemRequired": true,
"invisible": false,
"readonly": false,
"autofill": false
}
],
"alertType": "Default",
"formType": "Quick",
"weatherAlert": false,
"channels": {
"email": {
"send": true,
"requestConfirmation": false
},
"push": {
"send": true
}
},
"facilities": {
"facilities": [],
"areas": []
},
"message": {
"priority": "Emergency",
"basic": {
"message": "This is a test message from - 9db04d21-8daf-4a6d-bd67-631d9766c410 - 3b423a89-baf2-4a84-acad-e645865bbb6a",
"subject": "Bulk Test message 9db04d21-8daf-4a6d-bd67-631d9766c410 - 3b423a89-baf2-4a84-acad-e645865bbb6a"
},
"files": [],
"language": "en-us",
"translate": false
},
"recipients": {
"contactIds": [],
"groupIds": [],
"mandatoryGroupIds": [],
"contacts": [],
"groups": [],
"directories": [],
"searchFilters": [
{
"filter": {
"requireMembership": false,
"mandatoryAlerting": false,
"conditions": [
{
"field": "tag.globalRoles",
"expression": "oneOf",
"mapping": "tag.globalRoles",
"values": [
"IMT"
]
},
{
"field": "meta.iMTFacilities.IMTFacility",
"expression": "oneOf",
"mapping": "meta.iMTFacilities.IMTFacility",
"values": [
"ABQ5"
]
}
]
},
"displayName": "",
"type": "",
"group": {}
}
]
},
"schedule": {
"type": "Hickory",
"duration": 1440,
"scheduled": false,
"lastOccurrenceError": false
},
"sender": {
"callerId": "8334193463",
"displayName": "Johnson Huels",
"email": "alerts@nagdom.com"
},
"hidden": false,
"relatedAlertActions": {
"disableReplyAll": false
},
"publicAlert": false,
"requestConfirmation": false,
"clientContext": {
"templateId": null,
"isResend": false,
"clientId": "OpenAPI-Generator%2F1.0.0%2Fcsharp"
}
},
"correlationKey": "3b423a89-baf2-4a84-acad-e645865bbb6a",
"async": true
}
]
}
{
"jobId": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"alertResults": [
{
"correlationKey": "f9a9d09d-3ec7-4379-88a1-bf77b7d5b6dc",
"isSuccess": true
},
{
"correlationKey": "4bc36c98-e60a-4e00-a373-3d94d38c69ab",
"isSuccess": true
},
{
"correlationKey": "0715ec9f-99df-4264-98a5-d76f3d902f9e",
"isSuccess": true
},
{
"correlationKey": "b307d3f7-6823-4ab1-b007-58ca51a43e66",
"isSuccess": true
},
{
"correlationKey": "c350a634-f9b3-4960-826e-48e306c7025f",
"isSuccess": true
},
{
"correlationKey": "95f7ab1b-1be4-4cc8-b9ee-5ac365557bc7",
"isSuccess": true
},
{
"correlationKey": "524fdf1f-ac73-48f1-9ab8-ce7bdf9ebbb9",
"isSuccess": true
},
{
"correlationKey": "f1b095f8-73f1-4b97-a405-5ec1c36738a6",
"isSuccess": true
},
{
"correlationKey": "4ab7f3cc-9061-44eb-9284-7dbdd69ef632",
"isSuccess": true
},
{
"correlationKey": "3b423a89-baf2-4a84-acad-e645865bbb6a",
"isSuccess": true
}
],
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
3. Wait for bulk alerts to complete
Use the jobId from the BulkSendAlertsResponse to check progress using the Jobs API /api/v4/{tenantId/jobs/{jobId}
Note
Please use at least a 1 second interval between requests to /api/v4/{tenantId/jobs/{jobId}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 2
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 2
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 2
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 4
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 4
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 5
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 6
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 6
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 8
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Running",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 8
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}
GET - /api/v4/9331/jobs/03e9dae0-2a6b-474c-a51e-8e7428cc9014
{
"item": {
"id": "03e9dae0-2a6b-474c-a51e-8e7428cc9014",
"tenantId": "9331",
"timestamp": "/Date(1772566641606+0000)/",
"state": "Success",
"isSuccess": false,
"type": "BulkAlert",
"metadata": {
"tags": {},
"statistics": {
"totalProgress": 10,
"progress": 10
},
"attributes": {},
"tenantId": "9331",
"ownerId": "1075341"
}
},
"status": {
"isSuccess": true,
"errorCode": "None",
"validationFailures": [],
"messages": []
},
"hasErrors": false,
"isValid": true
}