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