in What can I?

DEVELOPERS API

Developers API is to provide specifications of the HTTP based PUSH API, provided by Cozy Vision Technologies for sending automated SMS via Internet. A Push Service receives a network request, verifies it and delivers a Push Message to the appropriate user, if the User is offline, the message is queued until the User comes online.

This is for the Developers and clients who plans to integrate their systems with Cozy Vision’s SMS PUSH Service.

REQUIRED ENVIRONMENT

In order to use the HTTP based API, first you need to have a system with an internet connectivity. This connectivity may be direct to the internet or via a firewall or proxy server. For sending SMS, you must have a web server that is able to send outgoing requests to the Internet. This is one of the simpler server-based forms of communication. It can be used in the form of a HTTP, GET or POST. All calls to the API will be URL-encoded. The parameter tags are case sensitive. To send messages: all required details are sent to a predetermined URL.

SUPPORTED CHARACTER SETS

GSM 03.38 Encoding. The standard SMS mobile-phone character set is used universally to send text messages. The standard character set allows up to 160 characters, which may include few of the Roman alphabets and the most common accented forms, certain special characters, and few Greek alphabets.

It includes the following characters:

@ £ \ $ ¥ è é ù ì ò Ç \ n Ø ø \ r Å å ? _ F ” ? O ? ? S T ? Æ æ ß É ! \ ” # ¤ % & ‘ ( ) * + , – ../ 0 1 2 3 4 5 6 7 8 9 : ; < = > ? ¡ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ? Ö Ñ Ü § ¿ a b c d e f g h I j k l m n o p q r s t u v w x y z ö ñ ü à ä Ä { } \ ~ [ ] |

Note:

All extended characters will take two characters to send. Extended characters are:

£ ¥ è é ù ì ò Ç Ø ø Å å Δ Φ Γ Λ Ω Π Ψ Σ Θ Ξ Æ æ ß É ¤ ¡ Ä Ö Ñ Ü § ¿ ä ö ñ ü à

Extended character like € takes three characters to send.

SMPP

HTTP

HTTP API can be used by the clients to send messages from Cozy Vision’s server. The HTTP API URL is in the following format: https://www.smsalert.co.in/api/push?apikey=&route=&sender=&mobileno=&text=

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

NAMEPARAMETERDESCRIPTION
API KEYAPIKEYAPI KEY GENERATED FROM YOUR SMS ACCOUNT ROUTE SYSTEM NAME OF THE ROUTE (CAN BE OBTAINED FROM API BUILDER)
ROUTEROUTESYSTEM NAME OF THE ROUTE (CAN BE OBTAINED FROM API BUILDER)
SENDER IDSENDER IDSENDER ID ASSIGNED TO YOUR ACCOUNT

 

MOBILE NUMBERMOBILE NO.MOBILE NUMBER TO WHICH THE SMS IS TO BE SENT.THE DESTINATION MOBILE NUMBER CAN BE WITH OR WITHOUT 91. YOU CAN ALSO PROVIDE MULTIPLE NUMBERS IN COMMA SEPARATED FORMAT.
TEXTTEXTMESSAGE TO BE SENT

There are few optional parameters in the HTTP API which are systematically listed below:

NAMEPARAMETERDESCRIPTION
SCHEDULE SCHEDULEDATE AND TIME FOR SCHEDULING AN SMS (FORMAT: YYYY-MM-DD HH:MM:SS)
DRL URL DRL URL CALL BACK DELIVERY REPORT URL (URL ENCODED FORMAT)
REFERENCE REFERENCE REFERENCE NUMBER FOR EACH MESSAGE SEPARATED BY COMMA.

XML

The XML API can be used by clients to send SMS from Cozy Vision’s server.

The XML API URL is in the following format:

https://www.smsalert.co.in/api/xmlpush?data=

API Parameter Specifications: The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are listed below:

NAMEPARAMETER DESCRIPTION
DATADATAXML FORMATTED DATA

EXAMPLE OF DATA

<?xml version=’1.0′ encoding=’ISO-8859-1′?>
<message>
<user apikey=’xxxxxxxxxx’ route=’xxxxx’ />
<sms text=’test sms from xml api’>
<address from=’TESTIN’ to=’xxxxxxxxxx’ />
<address from=’TESTIN’ to=’xxxxxxxxxx’ />
</sms>
<sms text=’second test sms from xml api’>
<address from=’TESTIN’ to=’xxxxxxxxxx’ />
</sms>
</message>

REST

5

FTP​

6

JAVA