AlertBlast API

AlertBlast API Documentation

Auth

Auth | Exchange refresh token for new access token

POST 
https://api.myalertblast.com/ocbapi/auth/token

Parameter

Field Type Description
grant_type String

password or refresh_token
client_id String

Oauth Client ID
client_secret String

Client Secret
refresh_token String

Refresh Token

Success 200

Field Type Description
access_token String

Access (Bearer) Token.
refresh_token String

Refresh token to get new Bearer Token.
scope String

Users scope who requested token
token_type String

type of token- usually Bearer.

Send a Sample Request

url

Parameters

json
String
String
String
String

Auth | Request Access Token

POST 
https://api.myalertblast.com/ocbapi/auth/token

Parameter

Field Type Description
grant_type String

password or refresh_token
client_id String

Oauth Client ID
client_secret String

Client Secret
username String

Username
password String

Password

Success 200

Field Type Description
access_token String

Access (Bearer) Token.
refresh_token String

Refresh token to get new Bearer Token.
scope String

Users scope who requested token
token_type String

type of token- usually Bearer.

Send a Sample Request

url

Parameters

json
String
String
String
String
String

CDR

CDR | Read CDR

POST 
https://api.myalertblast.com/ocbapi?object=cdr&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
phone_number String

Phone Number to Lookup
message_type String

mms or sms
start_time String

Start Time for search: YYYY-MM-DD h24:mi:ss
end_time String

End Time for search: YYYY-MM-DD h24:mi:ss

Send a Sample Request

url

Headers

String

Parameters

json
String
String
String
String

Contacts

Contacts | Add Contact to Group(s)

POST 
https://api.myalertblast.com/ocbapi?object=contacts&action=appendgroup

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id Number

ID or id list (comma separated) of groups
phone_number optional String

10 digit phone number of the contact to edit (accepts comma separated numbers)
contact_id optional String

ID of the contact you want to append groups to (accepts comma separated id's)

Send a Sample Request

url

Headers

String

Parameters

json
Number
String
String

Contacts | Create Contact Group

POST 
https://api.myalertblast.com/ocbapi?object=contactgroups&action=create

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
groupname String

Name of Group
description String

Group Description
teams_webhook optional String

Option Teams Webhook

Success 200

Field Type Description
group_id Number

ID of the group returned

Send a Sample Request

url

Headers

String

Parameters

json
String
String
String

Contacts | Create Contact

POST 
https://api.myalertblast.com/ocbapi?object=contacts&action=create

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
multi_group optional Number

Group(s) to add contact to. If single just supply ID, if multiple comma separated
firstname optional String

First Name
lastname optional String

Last Name
phone_number String

Phone number, mandatory
description optional String

Contact Description
email optional String

Contact Email
alt_number optional String

Alternate Number
language optional String

contacts preferred language

Send a Sample Request

url

Headers

String

Parameters

json
Number
String
String
String
String
String
String
String

Contacts | Delete Contact From Group

POST 
https://api.myalertblast.com/ocbapi?object=contacts&action=removegroup

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id Number

ID of the group to remove the contact from
phone_number optional String

10 digit phone number of the contact to edit
contact_id optional Number

ID of the contact you want to remove from groups
purge optional String

empties referenced contact group. No other values needed if using this value of "yes"

Allowed values: "yes"

Send a Sample Request

url

Headers

String

Parameters

json
Number
String
Number
String

Contacts | Delete Contact Group

POST 
https://api.myalertblast.com/ocbapi?object=contactgroups&action=delete

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id String

Contact Group ID WARNING: This cannot be undone

Success 200

Field Type Description
None String

Send a Sample Request

url

Headers

String

Parameters

json
String

Contacts | Delete Contact

POST 
https://api.myalertblast.com/ocbapi?object=contacts&action=delete

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id Number

Id of the contact to delete
phone_number String

Phone number, mandatory

Send a Sample Request

url

Headers

String

Parameters

json
Number
String

Contacts | Get Contact Groups

POST 
https://api.myalertblast.com/ocbapi?object=contactgroups&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Success 200

Field Type Description
company String

Company
username String

Group owner username
groupname String

Name of Group
created_on String

Date group created
type String

type of contact group

Send a Sample Request

url

Headers

String

Contacts | Get Contacts

POST 
https://api.myalertblast.com/ocbapi?object=contacts&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id optional String

Contact Group ID
phone_number optional String

Contacts primary phone number (10 digit)

Success 200

Field Type Description
id optional Number

Contact ID
multi_group optional Number

Group ID membership Array
firstname optional String

First Name
lastname optional String

Last Name
phone_number optional String

Contact phone number
description optional String

Contact Description
created_on optional String

Date contact created
email optional String

Contact Email
alt_number optional String

Alternate Number
approved optional String

yes or no if approved
language optional String

contacts preferred language

Send a Sample Request

url

Headers

String

Parameters

json
String
String

End User

End User | User Info

POST 
https://api.myalertblast.com/ocbapi/?object=user_info

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Send a Sample Request

url

Headers

String

Jobs

Jobs | Delete Jobs

POST 
https://api.myalertblast.com/ocbapi?object=jobs&action=delete

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id Number

Job ID

Success 200

Field Type Description
200 Number

Send a Sample Request

url

Headers

String

Parameters

json
Number

Jobs | Read Jobs

POST 
https://api.myalertblast.com/ocbapi?object=jobs&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
id optional String

Contact Group ID
target String

Allowed values: "saved", "scheduled", "sent", "sent_detail"

Success 200

Field Type Description
id optional Number

Job ID
username optional String

User Name
company optional String

Company
job_name optional String

Name of campaign for this job
job_id optional String

ID of the campaign this will start
created_on optional String

Date created
send_time optional String

Time/Date to send
save_type optional String

Job Type
webhook_url optional String

URL to run the job (warning this will start the job)
active optional String

job status
repeat optional String

days to repeat job ARRAY. 0=mon..6=sun
last_sent optional String

last time job was run (if recurring/repeat)

Send a Sample Request

url

Headers

String

Parameters

json
String
String

Messaging

Messaging | Send New Message

POST 
https://api.myalertblast.com/ocbapi/?object=send_message

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
job_name String

Name of Job
description String

Job Description
message_text String

Message text, can contain tokens.
message_from String

From number, must be valid number on account
transcribe_text String

Use transcription services for TTS

Allowed values: "yes", "no"

sms_contacts String

contact group ids, comma separated
voice_contacts String

contact groups ids, comma separated
email_contacts String

contact groups ids, comma separated
page_contacts String

page contact groups ids, comma separated
get_response String

whether to ask for responses (2 responses)

Allowed values: "yes", "no"

resp_title String

Response title to display to the user
ask_response1 String

Response for button 1
ask_response2 String

Response for button 2
use_list String

If using dynamic messages for each contact in group

Allowed values: "yes", "no"

message_list String

JSON object of messages, see below for example. When using this feature if a contact in the group is not referenced in the list by phone number they are ignored and skipped... no message will be sent. This also disables all other mediums of messaging besides SMS if supplied.

 
{
    "7045556666": "Test Message 1",
    "7045559999": "Test Message 2"
}

Send a Sample Request

url

Headers

String

Parameters

json
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String

Reminders

Reminders | Create Reminder Contact

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=create

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: contact
group_id Number

This is the ID of the existing reminder group
firstname String

can use [firstname] as token in message
lastname String

can use [lastname] as token in message
phone_number Number
description String

Description of Appointment, can use [desc]
appt_on String

YYYY-MM-DD h24:mi:ss [appt]

Default value: YYYY-MM-DD h24:mi:ss

Send a Sample Request

url

Headers

String

Parameters

json
String
Number
String
String
Number
String
String

Reminders | Create Reminder Group

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=create

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: group
job_name String
active String
reminder_seconds String

Number of seconds prior to appt time to send
reminder_message String

Max Message length 135 characters
from_number String

Authorized number in account to send sms from

Send a Sample Request

url

Headers

String

Parameters

json
String
String
String
String
String
String

Reminders | Delete Reminder Contact

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=delete

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: contact
group_id Number

This is the ID of the existing reminder group
id Number

This is the ID of the contact to delete

Send a Sample Request

url

Headers

String

Parameters

json
String
Number
Number

Reminders | Delete Reminder Group

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=delete

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: group
id String

ID of the group you are deleting

Send a Sample Request

url

Headers

String

Parameters

json
String
String

Reminders | Edit Reminder Contact

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=edit

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: contact
id Number

This is the ID of the contact
firstname optional String

can use [firstname] as token in message
lastname optional String

can use [lastname] as token in message
phone_number optional Number

must be an authorized number or edit will fail
description optional String

Description of Appointment, can use [desc]
appt_on optional String

YYYY-MM-DD h24:mi:ss [appt]

Default value: YYYY-MM-DD h24:mi:ss

Send a Sample Request

url

Headers

String

Parameters

json
String
Number
String
String
Number
String
String

Reminders | Edit Reminder Group

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=edit

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: group
id optional String

ID of the Reminder Group to edit
job_name optional String
active optional String
reminder_seconds optional String

Number of seconds prior to appt time to send
reminder_message optional String

Max Message length 135 characters
from_number optional String

Authorized number in account to send sms from

Send a Sample Request

url

Headers

String

Parameters

json
String
String
String
String
String
String
String

Reminders | Read Reminder Contacts

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Allowed values: "contacts"

group_id Number

Reminder Group ID to read contacts from

Send a Sample Request

url

Headers

String

Parameters

json
String
Number

Reminders | Read Reminder Groups

POST 
https://api.myalertblast.com/ocbapi?object=reminders&action=read

Header

Field Type Description
Authorization String

Default value: Bearer REPLACE_WITH_TOKEN

Parameter

Field Type Description
target String

Default value: group

Send a Sample Request

url

Headers

String

Parameters

json
String

Generated with apidoc 0.50.4 - Wed Oct 05 2022 11:39:35 GMT-0400 (Eastern Daylight Time)