Send a personalised SMS alert to contact groups
Send a personalised SMS alert to contact groups. Specify client ref, contact group to use, contacts, lookups for personalisation, contact sets, alert type, contact set to use, content, sender and shortlink.
{
"version" : "latest",
"apiKey" : "abcdefghijklmnopqrstuvwxyz",
"clientRef" : "my-reference",
"options": {
"notification" : "poll",
"notificationType" : "json"
},
"contactGroup" : {
"inlineContactGroup" : {
"name": "test",
"contacts": [
{
"id": "name-0",
"sms": "+447976100000",
"email": "email-0@mycompany.com",
"call": "+447976200000",
"lookups": {
"firstname": "fname-0",
"lastname": "sname-0"
}
},
{
"id": "name-1",
"sms": "+447976100001",
"email": "email-1@mycompany.com",
"call": "+447976200001",
"lookups": {
"firstname": "fname-1",
"lastname": "sname-1"
}
},
{
"id": "name-2",
"sms": "+447976100002",
"email": "email-2@mycompany.com",
"call": "+447976200002",
"lookups": {
"firstname": "fname-2",
"lastname": "sname-2"
}
},
{
"id": "name-3",
"sms": "+447976100003",
"email": "email-3@mycompany.com",
"call": "+447976200003",
"lookups": {
"firstname": "fname-3",
"lastname": "sname-3"
}
}
],
"sets": [
{
"name": "sales",
"ids": [ "name-0", "name-2" ]
},
{
"name": "management",
"ids": [ "name-1", "name-3" ]
}
]
}
},
"alert" : [
{
"alertType" : "sms",
"tag" : "tag1",
"contactSets" : [ "sales" ],
"content" : "This is a sales team message for {firstname} {lastname} on {datetime-DD/MM/YYYY}. Click {shortlink} to let us know you've seen this.",
"contentEncoding" : "utf8",
"sender" : "My Company",
"lookups": {
"performLookups": true,
"uniqueLookups": true,
"shortlink": {
"reference": "a-reference",
"url": "https://my-companies-url.com/alertinghub-click-through"
}
}
},
{
"alertType" : "sms",
"tag" : "tag1",
"contactSets" : [ "all" ],
"content" : "This is a company wide message for {firstname} {lastname} on {datetime-DD/MM/YYYY}. Click {shortlink} to let us know you've seen this.",
"contentEncoding" : "utf8",
"sender" : "My Company",
"lookups": {
"performLookups": true,
"uniqueLookups": true,
"shortlink": {
"reference": "a-reference",
"url": "https://my-companies-url.com/alertinghub-click-through"
}
}
}
]
}
