Specifying who receives the alerts
When sending alerts you must specify at least one receiver of the alert. There are many ways to let the system know who you would like to receive the alert as described below (you can specify any or all of these in each alert section when sending alerts but you must specify at least one).
Receivers can be specified in 3 broad categories:
- Recipients – simple phone numbers and email addresses.
- Contacts – a contact holds phone numbers for sms/voice and an email address under a unique name or identifier. It is that identifier that is specified when sending the alert and the system will lookup the relevant number or email address to use. Contacts can also hold other information that allows personalisation of alerts to be made.
- Contact set – a pre-generated set of contact identifiers; this allows common groupings of contacts to be made and the alert simplified (e.g. you could have a contact set called ‘sales_team’ and you simply specify that when sending the alert; the platform will lookup all the relevant contacts and ensure that the alert reaches them by their relevant number of email address.
When using contacts or contact sets these must refer to items that have been defined in a contact-group (think of a contact-group as an entire address list) and that contact-group must have been specified in the alert itself.
| Parameter within the alert section | Description | JSON example |
|---|---|---|
| recipients | Array of phone numbers or email addresses | [ "+447976100001", "+447976100002" ] |
| recipientList | Comma delimited string list of recipients | "+447976100001",+447976100002" |
| storedRecipients | Previously stored recipientList. Would have been stored using the /storecontent api. | See below |
| contacts | Array of contacts | [ "contact-1" , "contact-2" ] |
| contactList | Comma delimited list of contacts | "contact-1,contact-2" |
| storedContactList | Previously stored contactList. Would have been stored using the /storecontent api. | See below |
| contactSets | Array of contact sets | [ "sales_team" , "security" ] |
| contactSetList | Comma delimited list of contact sets | "sales_team,security" |
| storedContactSetList | Previously stored contactSetList. Would have been stored using the /storecontent api. | See below |
Specifying stored content
When specifying storedRecipients, storedContactList, storedContactSetList or any other stored item you need to provide either the unique id (storeId) of the stored item provided by Alerting Hub as part of the response to a /storecontent API call or the unique name (storeName) you gave the store when creating it via the /storecontent API call. Here are some examples of specifying a previously stored item:
"storedRecipients": {
"storeName": "myStoredSms"
}
"storedContactSetList": {
"storeId": "e5299a3e-03c8-4cb7-9732-1d5d80f8b97f"
}