Partner APIs

All Partner APIs require authentication and authorization. APIs use Basic Auth.

Note : You will need your partner account ID and API key for Basic Auth. To become a partner please send an email to info@alertcentral.com. 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 Account

Method : POST
Endpoint : /partner_apis/account
Description : This API can be used to create new accounts under the partnership. Once an account is created the Account ID (Namespace) and API Key returned can be used to schedule reminders for that account.
Use APIs here to schedule reminders.

Input
user_id (required)
Email address for the account. Each account will need its own email address.
password (required)
Password. 8 to 15 characters.
account_name (required)
Account name. Name of the practice. Eg : "Smile Dental Inc"
caller_id (required)
Front desk number of the practice. This is where patients who want rescheduling will call in.
time_zone (required)
Eg : US/Eastern
Output
success
true, false
reason
A reason for failure if the API call failed
api_key
* API Key for the newly created account. Use for scheduling reminders for this account.
namespace
* Account ID for the newly created account. Use for scheduling reminders for this account.

API Partner Alert

Method : POST
Endpoint : /partner_apis/alert
Description : This REST API can be used to post new alerts for a partner account.
Input
account_name (required)
Account Name for which this alert is being posted. Eg : "Smile Dental"
sub_account_name (optional)
Sub Account Name for which this alert is being posted. Leave this empty if there is no sub account Eg : "Finance Dept"
partner_account_id (optional)
Partner Account ID is used to identify this account on the partner's end uniquely. Leave this empty if there is no partner account id.
Eg : A GUID : "51ac38f33aed44d49a81aaba639".
Database Row ID : "42223992932".
Other unique identifiers.
script_id (optional. Default is adhoc_message_with_reply)
One of adhoc_message, adhoc_message_with_reply
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
success
true, false
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 : /partner_apis/alert/{alert_guid}?account_name={account_name}&sub_account_name={sub_account_name}&partner_account_id={partner_account_id}
Description : This REST API can be used to get previously posted alert. sub_account_name & partner_account_id are optional.
Output
success
true, false
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