APIs
All APIs require authentication and authorization. APIs use Basic Auth.
Note : You will need your account ID and API key for Basic Auth. To get authentication details please
send an email to info@alertcentral.com with your registered account id. All APIs support sending
payload as query strings or JSON payload in the body. For sending payload a JSON in body, please set the
'Content-Type' as 'application/json'.
API Alert
Method : POST
Endpoint : /apis/alert
Description : This REST API can be used to post new alerts.
Input
destination (required)
Mobile number, landline number, email address
channel (required)
One of the following strings : "voice", "email", "sms"
schedule_time (optional)
GMT time the alert should be scheduled for. If omitted alert will be sent immediately.
Eg : "03/20/2018 14:00"
alert_data (optional)
JSON dictionary with "recipient_name", "appointment_time" and other info. This payload can
change based on each account's needs
Output
reason
A reason for failure if the API call failed
alert_guid
A unique identifier for the alert that was posted. This alert_guid can be used to GET, DELETE an alert.
Method : GET
Endpoint : /apis/alert/{alert_guid}
Description : This REST API can be used to get previously posted alert.
Output
reason
A reason for failure if the API call failed
alert_guid
A unique identifier for the alert that was posted.
alert_data
JSON dictionary that was posted with the alert
alert_last_response
Last response from the user. Digits pressed, Spoken phrases can be found here.
alert_status
Status if the alert. Alerts typically go from "new", "picked", "sent" states. There are other states also involved.
alert_destination
Destination where the alert was sent
API Person
Method : POST
Endpoint : /apis/person
Description : This REST API can be used to add persons to your account.
Input
destination (required)
Mobile number, landline number, email address
channel (required)
One of the following strings : "voice", "email", "sms"
name (required)
The name of the person
welcome_message (optional)
Optional welcome message. To request documents add the necessary content here. Eg : "Welcome to the system. Please send your Health Insurance card."
document_name (optional)
If documents are being requested please give a document name here. Only "sms" channel supports receiving documents.
Output
reason
A reason for failure if the API call failed
Method : GET
Endpoint : /apis/person/{person name}
Description : This REST API can be used to get person from your account.
Output
reason
A reason for failure if the API call failed
name
Name retrieved from your account
end_points
List of destinations and channels
API Message
Method : POST
Endpoint : /apis/message
Description : This REST API can be used to post messages to multiple person.
Input
message (required)
A message for the user
subject (optional)
A subject for the message. This subject is required for sending email messages.
channel (required)
One of "voice", "sms", "email"
schedule_time (optional)
GMT time the alert should be scheduled for. If omitted alert will be sent immediately.
Eg : "03/20/2018 14:00"
recipients (required)
A list of recipients with "name" and "destination" for each recipient. Eg : [{"name": "Person A", "destination" : "5089909923"}, {"name": "Person B", "destination" : "4083811982"}]
Output
reason
A reason for failure if the API call failed
alert_guids
List of alert_guids one for each succesful message dispatched.