SMS Alert
-
-
POST
-
POST
-
POST
-
POST
-
POST
-
GET
-
GET
-
-
-
GET
-
POST
-
POST
-
POST
-
POST
-
-
-
GET
-
POST
-
POST
-
POST
-
POST
-
-
-
GET
-
POST
-
POST
-
POST
-
-
-
POST
-
POST
-
-
-
POST
-
POST
-
POST
-
-
-
POST
-
POST
-
POST
-
-
-
POST
-
POST
-
-
-
POST
-
POST
-
SMS Alert
HTTP Status Codes
SMSAlert uses standard HTTP status codes to communicate errors:
Status Code |
Value |
200 |
OK – Everything went as planned. |
202 |
Accepted – Request accepted. |
400 |
Bad Request – Something in your header or request body was malformed. |
401 |
Unauthorised – Necessary credentials were either missing or invalid. |
402 |
Payment Required – The action is not available on your plan, or you have exceeded usage limits for your current plan. |
403 |
Your credentials are valid, but you don’t have access to the requested resource. |
404 |
Not Found – The object you’re requesting doesn’t exist. |
409 |
Conflict – You might be trying to update the same resource concurrently. |
429 |
Too Many Requests – You are calling our APIs more frequently than we allow. |
5xx |
Server Errors – Something went wrong on our end. Please try again. |
Account
POST Login / Profile
params
apikey
5e0741771f08e
API Key generated from your SMS account
Example Request
Example Response
Example Response
Account
POST Register
Headers
Content-Type
application/x-www-form-urlencoded
params
rtype
self
Mandatory field for creating the account via api
Body urlencoded
data[User][username]
Ram2254mm
User Name
data[User][mobilenumber]
8010551055
Mobile Number
data[User][emailid]
ram@cozycision.com
Email Id
data[User][firstname]
Ram
First Name
data[User][lastname]
Kumar
Last Name
Example Request
Example Response
Account
POST Forgot Password
Headers
Content-Type
application/x-www-form-urlencoded
Body urlencoded
data[User][username_email]
shanky@cozyvision.com
Registered Mail Id
Example Request
Example Response
Example Response
Account
POST Change Password
Headers
Content-Type
application/x-www-form-urlencoded
Body urlencoded
apikey
5dd7cd37e7239
API Key generated from your SMS account
pwd
Sh@12345678
Old Password
newpwd
Sh@61257061
New Password
cnfpwd
Sh@61257061
Confirm Password
Example Request
Example Response
Account
POST Update Profile
params
apikey
5e0741771f08e
API Key generated from your SMS account
firstname
Cozy
First Name
lastname
Vision
Lastname
mobilenumber
8010551055
Mobile Number
emailid
support@cozyvision.com
Email Id
fcm_id
6464646
Example Request
Example Response
Example Response
Example Response
Account
GET Balance Check API
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
Example Request
Example Response
Example Response
Account
GET Get Available Sender Id List
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
Example Request
Example Response
Example Response
Group
GET Get Group List
params
apikey
5e0741771f08e
API Key generated from your SMS account
limit
10
To get the list of records available per page. Default value for page is 10.
page
1
To get the list of records from the respective pages. Default value for page is 1.
q
order
desc
Example Request
Example Response
Example Response
Group
POST Create Group
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
name
Cozy Test
Group Name, that you wish to create
Example Request
Example Response
Example Response
Example Response
Group
POST Delete Group
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
id
2227
Group Id
Example Request
Example Response
Group
POST Edit Group
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
id
2227
Group Id
name
Hello
The Group Name that you want to modified
Example Request
Example Response
Group
POST Send to Group
params
apikey
5e0741771f08e
API Key generated from your SMS account
id
2230,2225
Group Id
sender
TESTIN
Sender ID assigned to your account
text
Hello Cozy Vision
Message to be sent
route
transactional
schedule
2020-05-22 19:02
Example Request
Example Response
Contact
GET Contact List
params
apikey
5e0741771f08e
API Key generated from your SMS account
group_id
2225
Group Id
limit
10
To get the list of records available per page. Default value for page is 10.
page
1
To get the list of records from the respective pages. Default value for page is 1.
order
desc
Example Request
Example Response
Example Response
Contact
POST Create Contact
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
grpname
Test
Group Name in which you want to create contact
name
Cozy Vision
Contact Name of the Contact
number
8010551055
Contact Number of the Contact
Example Request
Example Response
Example Response
Contact
POST Import Contact
Headers
Content-Type
application/x-www-form-urlencoded
Body urlencoded
data
Xml formatted data
Example Request
Example Response
Example Response
Contact
POST Edit Contact
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
id
3079347
Contact Number Id
name
Cozy Vision
Contact Name of the Contact
number
918010551055
Contact Number of the Contact
Example Request
Example Response
Contact
POST Delete Contact
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
id
3079347
Contact Number Id
Example Request
Example Response
Template
GET Get Templates List
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
order
desc
page
1
To get the list of records from the respective pages. Default value for page is 1.
limit
10
To get the list of records available per page. Default value for page is 10.
Example Request
Example Response
Example Response
Template
POST Create Template
params
name
Test5
Template Name
text
test+smsp
SMS Content
apikey
5dd7cd37e7239
API Key generated from your SMS account
Example Request
Example Response
Template
POST Edit Template
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
name
test
Template Name
text
test+sms
SMS Content
id
17099
Template Id
Example Request
Example Response
Example Response
Template
POST Delete Template
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
id
17086
Template Id
Example Request
Example Response
Send SMS
POST Send a SMS
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
sender
VIEWIT
Sender ID assigned to your account
mobileno
8010551055
Mobile number to which the SMS is to be sent.The destination mobile number can be with or without country code. Also provide multiple numbers in comma separated format.
text
Hello%20Cozy
Message to be sent in url-encoded format
Example Request
Example Response
Send SMS
POST XML Push API Format
params
data
<?xml version=’1.0′ encoding=’UTF-8′?> <message> <user apikey=’5e0741771f08e’ route=’Transactional’ /> <sms text=’test sms from xml api’> <address from=’TESTIN’ to=’8010551055′ /> <address from=’TESTIN’ to=’8010551055′ /> </sms> <sms text=’second test sms from xml api’> <address from=’TESTIN’ to=’8010551055′ /> </sms> </message>
Xml formatted data
Example Request
Example Response
Schedule SMS
POST Schedule a SMS
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
sender
VIEWIT
Sender ID assigned to your account
mobileno
8010551055
Mobile number to which the SMS is to be sent.The destination mobile number can be with or without country code. Also provide multiple numbers in comma separated format.
text
Hello%20Cozy
Message to be sent in url-encoded format
schedule
2019-11-22 5:49
Date and time for updated schedule (Format: YYYY-MM-DD HH:MM:SS)
Example Request
Example Response
Example Response
Example Response
Schedule SMS
POST Edit Schedule
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
batchid
32721115
Batch Id of the scheduled sms, received while sending the sms through API
schedule
2019-11-25 10:46:42
Date and time for updated schedule (Format: YYYY-MM-DD HH:MM:SS)
Example Request
Example Response
Schedule SMS
POST Cancel Schedule
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
batchid
32669767
Batch Id of the scheduled sms, received while sending the sms through API
Example Request
Example Response
Reports
POST Sent SMS Report
Headers
Content-Type
application/x-www-form-urlencoded
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
limit
10
To get the list of records available per page. Default value for page is 10.
page
1
To get the list of records from the respective pages. Default value for page is 1.
q
schedule
1
Example Request
Example Response
Reports
POST Obtaining Message Delivery Report (Push)
params
apikey
5dd7cd37e7239
API Key generated from your SMS account
sender
VIEWIT
Sender ID assigned to your account
mobileno
8010551055
Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.
text
Hello test is
Message to be sent
reference
123456
e.g. LTXXXXX. Also support comma separated value if multiple mobile number specified
dlrurl
http%3A%2F%2test.com%2Fb418f7cb-1587-4ce0-a81d-cada4e2279c9
Call back delivery report url(url encoded format) e.g. http://www.test.com/dlr.php
Example Request