AlertBox API Configuration

Introduction

Alertbox is a feature rich, future ready state-of-the-art communications platform with functionality that enables quick and easy transmission of messages in multiple modalities including SMS, voice, Email etc. As a result of our relentless effort to enhance and optimize customer experience, bulk messaging, voice messaging, 2-way messaging, bulk-mail and many other features have been incorporated under one single user friendly panel for ease of access and comfort. Our APIs hold the potential to power all these features from an application of your choice.

Our API Reference is organized by topics, such as MessagingAPI or VoiceAPI. Each topic is prefaced with a general overview that describes how our API can be used within the context of that topic, followed by reference documentation of specific API endpoints.

Alertbox strives to create a developer-first platform with interactive documentation and 24/7 support. Explore our API capabilities and please let us know how we can better empower your development team to better serve your customers.

HTTP API Configuration

The parameters to be used are:

username : XXXXXXX

password : your_password

api_password : (Show api_password)

sender : Alphanumeric / Number SenderID for GSM Recipients

to : Recipient Number (one at a time)

message : Actual Message to be sent

result_type : result_type=2 to get both Message_Id and mobile number as output

priority : Route id for the selected route(4 - OTP , 8 - Promo , 11 - Enterprise , 12 - Scrub , 18 - Intrl)

* In the password field either account password or api_password can be used

* The API works on GET and POST METHOD

---

XML API Configuration

XML API for sending Single SMS :

* In the password field either account password or api_password can be used.

$data=
"<?xml version='1.0' encoding='utf-8'?>
<MESSAGE >
<USER USERNAME='username' PASSWORD='password'/>
<SMS TEXT='Hi, this is a test message.' MESGTYPE='' SENDER='TEST' PRIORITY='1' >
<ADDRESS TO='XXXXXXXXXX' />
</SMS>
</MESSAGE>";>

$data=urlencode($data);

http://alertbox.in/xmlapi.php?data=$data

XML API For sending Multiple SMS :

<$data=>
"<?xml version='1.0' encoding='utf-8'?>
<MESSAGE>
<USER USERNAME='username' PASSWORD='password'/>
<SMS TEXT='Hi, this is a test message.' MESGTYPE='' SENDER='TEST' PRIORITY='1' >
<ADDRESS TO='XXXXXXXXXX' />
<ADDRESS TO='XXXXXXXXXX' />
<ADDRESS TO='XXXXXXXXXX' />
<ADDRESS TO='XXXXXXXXXX' />
<ADDRESS TO='XXXXXXXXXX' />
</SMS>
</MESSAGE>";

$data=urlencode($data);

http://alertbox.in/xmlapi.php?data=$data

*To get xml output use the parameter xmloutput=1

eg:- http://alertbox.in/xmlapi.php?data=$data&xmloutput=1

* Use attribute PRIORITY in Element <SMS> to select credit type (4 - OTP , 8 - Promo , 11 - Enterprise , 12 - Scrub , 14 - voice , 16 - Email , 18 - Intrl).

* Use attribute MESGTYPE='0' for Normal Text Messge, MESGTYPE='1' for Unicode and MESGTYPE='2' for Flash in Element <SMS> to select message type.

* eg: <SMS TEXT='Hi, this is a test message.' MESGTYPE='0' SENDER='TEST' PRIORITY='1'>

* Use ' to use single quotes

To fetch Single DLR :

http://alertbox.in/fetchdlr.php?username=your_username&msgid=message_id

To fetch Multiple DLRs :

http://alertbox.in/fetchdlr.php?username=your_username&msgid=message_id1,message_id2,message_id3

*To get xml output use the parameter xmloutput=1

http://alertbox.in/fetchdlr.php?username=your_username&msgid=message_id&xmloutput=1

---

Voice HTTP API Configuration

The parameters to be used are :

username : XXXXXXXX

password : your_password

api_password : (Show api_password)

to : Recipient Emails (Separate by a coma [maximum of 10 at a time is allowed] )

voice_url : Url link of your voice mp3 file

voice_filename : Voice filename for your uploaded mp3 file

voice_id : Template ID of your voice file

* In the password field either account password or api_password can be used

* The API works on GET METHOD only

* Only mp3 file will support in API

API Output format for voice call, voiceid_VOICE_msgid (Ex: 111_VOICE_222 means 111 is voicefile id and 222 is voiceid)

---

Email HTTP API Configuration

The parameters to be used are :

username : XXXXXXXX

password : your_password

api_password : (Show api_password)

to : Recipient Emails (Separate by a coma [maximum of 10 at a time is allowed] )

subject : Subject Content (Minimum of 3 words should be present)

replyto : replyto emailid

sender : Full Email SenderID

display : Display Name

cright : Copyright name (Your Company name or Your name)

message : Email Content (Both php and/or text supported)

* In the password field either account password or api_password can be used

* The Email API works on POST METHOD only

* Balance check and DLR API works on GET METHOD only

---

Shortcode Configuration

Adding Keywords :

If you set 'Response Message', it will be send back to the user requesting the service.

If you set 'Forward to url', the response to keyword will be the response of that url.

We'll push traffic in your url with parameters "from"(mobile number) and "message"(message content).

If you set any one option the other one will be deleted automatically.

Adding SubKeywords :

Unlimited number of subkeywords can be added under a keyword

If you set 'Response Message', it will be send back to the user requesting the service.

If you set 'Forward to url', the response to keyword will be the response of that url.

We'll push traffic in your url with parameters "from"(mobile number) and "message"(message content)

---

Sender-ID Configuration

Adding Sender_ID :

All Fields are mandatory.

All Sender ID subject to administrator approval.

Sender ID must be 6 characters

For enterprise and otp, sample message content should be pure valid transactional content.

---

AlertBox Documentation

Introduction

Our Documentation is organized by topics, such as Simple / Dynamic / Unicode Messaging, SMPP accounts, One to Many and Email. Each topic is prefaced with a general overview that describes how our can be used within the context of that topic.

Simple Messaging

* For multiple numbers, use "ENTER" to seperate numbers. Don't use comma, semicolon etc.

Example :
98xxxxxxxx
98xxxxxxxx
98xxxxxxxx

* In Quick Push,uploaded file should only contain numbers.

Example :
98xxxxxxxx
98xxxxxxxx
98xxxxxxxx

* For international numbers, prefix country codes without appending zeroes.

Example :
For India, 9198xxxxxxxx

* Please do not copy and paste any content from any pages.

* Please select unicode to send unicode messages.

* For Tracking URL in sms, you have to add 'http://' or 'https://' infront of the tracking URL.

* Only one tracking URL is allowed in a sms, if you want to put more than one URL, please remove 'http://' or 'https://' in all URL except the tracking URL.

*For Voice call, 1 credit will be deducted for every 27 sec duration file.

---

Dynamic Messaging

This is an option to send different messages to different numbers.

The numbers to which messages are to be send must be saved in an excel file in csv(msdos) format.

You can upload a maximum of 10000 numbers at a time

The message field must not contain any comma.

Clicking on "Send" processes the uploaded file immediately.

Don't click any link while file is uploading.

Field 1 in CSV must always be Mobile Number.

Do not copy and paste any content from any pages. Type the contents on the Message box.

Example :
While Uploading a csv(msdos) having the following data,
9198xxxxxxxx,CLIENT NAME,BILL AMOUNT
9198xxxxxxxx,CLIENT NAME,BILL AMOUNT

for an example message, type, Hello #field2#, Your bill amount due is #field3#. Kindly pay, ignore if paid. Thanks ( Where #field2# will be the customer Name and #field3# will be the Amount )

Unicode messsages not supported in dynamic message

Dont blank any field in between other fields in csv file!

---

Unicode Dynamic Messaging

This is an option to send different messages to different numbers.

The numbers to which messages are to be send must be saved in an excel file in xlsx format.

You can upload a maximum of 50000 numbers at a time

The message field must not contain any comma.

Clicking on "Send" processes the uploaded file immediately.

Don't click any link while file is uploading.

Field 1 in Excel must always be Mobile Number.

Do not copy and paste any content from any pages. Type the contents on the Message box.

Example:
While Uploading a excel having the following data,
9198xxxxxxxx,CLIENT NAME,BILL AMOUNT
9198xxxxxxxx,CLIENT NAME,BILL AMOUNT

for an example message, type, Hello #field2#, Your bill amount due is #field3#. Kindly pay, ignore if paid. Thanks ( Where #field2# will be the customer Name and #field3# will be the Amount )

---

SMPP Account Creation

username should contains 8 characters and allowed only alphabetic and numeric!

* Please make sure that your registered email id is available since all details of smpp creation will be emailed to your registered email id! Please check and update your email from

---

One To Many

*This is a facility in which you can send message to a group from a mobile.

Format No.1 :
TYPE MyGroup*Groupid*CreditType*Senderid*Message and send to 7527024789 ( upto 149 character including keywords )

Format No.2 :
TYPE MyGroup*Groupid*CreditType*Senderid*MessageTemplateID and send to 7527024789

*For example :
To send to a group "testgroup" with groupid=1234 and senderid=TESTIN and message=Hello using enterprise credit, Type mygroup*1234*11*testin*Hello and send to 7527024789

*You have to register mobile number inorder to use this service.

*You can use this service only from this mobile number.

Please note: Unicode messages not supported

Parameters :

MyGroup - It is the keyword, no need to change.

Groupid - The group to which you want to send message.

CreditType - The credit type you want to use."11" for Enterprise credit, "12" for Scrub credit..

Senderid - The sender you want to use.

Message - The message content you want to send.

MessageTemplateID - The ID of a message template content you want to send. You can find the message template id in manage templates under Messaging.

---

FTP SMS Request

You can now send sms by simply uploading csv file in the below format via FTP credentials

Example :
mobile|sender|credit_type|unicode|message

For normal text content, unicode=0 and for unicode, unicode=1

For enterprise, credit_type=11,scrub=12,promo=8,otp=4

*Maximum of 1000 sms allowed in a csv file

---

Dynamic Email

*Upload file should be in csv format and the first field should be emailids and so on

Example :
.csv file should contain like xxx@gmail.com,abcd,100
Mail content like : Hello #field2#,your balance is #field3#.

From the above file and content, the output will be like
Hello abcd, your balance is 100.

*Please do not copy and paste any content from any pages.

*Please note: For Sending BULK EMAIL, please contact support team.

*Please note: Default SenderID is for testing purpose only

---

Compose Email

* For multiple Emails, use "ENTER" to seperate emails. Don't use comma, semicolon etc.

Example :
xxx@xxx.com
yyy@yyy.com
zzz@zz.com

* In Quick Push, uploaded file should only contain Emails.

Example :
xxx@xxx.com
yyy@yyy.com
zzz@zz.com

* Please do not copy and paste any content from any pages.

* Please note: For Sending BULK EMAIL, please contact support team.

* Please note: Default SenderID is for testing purpose only

* Please note: Minimum of 2 emailids is need to send email vis quick push

* For Tracking URL in email, you have to create short url in 'click to create smart url'.

* Only one tracking URL is allowed in a email.

---

Manage Email Sender-ID

The following Sender IDs are in your account. Click on the pencil icon to edit, or the 'x' icon to delete.

---

Contacts and Groups

Contacts can be uploaded in .txt or .csv format, provided the numbers/data are in any of the following formats:

Mobile Number
Example :
98xxxxxxxx

Mobile Number,Name
Example :
98xxxxxxxx,RECIPIENT NAME

Mobile Number,Name,E-Mail, Birth date, Anniversary date,Blood Group
Example :
98xxxxxxxx,RECIPIENT NAME,name@email.com,DD-MM-YYYY,DD-MM-YYYY,BLOOD GROUP

*You can upload a maximum of 100000 numbers in a group

*Maximum of 30 character is supported in 'Recipient name' column

*Please make sure that your upload file doesn't contains any DUPLICATE numbers

---

---

---