SMS Alert

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

https://www.smsalert.co.in/api/user.json?apikey=5e0741771f08e

params

apikey

5e0741771f08e

API Key generated from your SMS account

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "id": "19774",
        "username": "shanky005",
        "firstname": "Cozy",
        "lastname": "Vision",
        "mobilenumber": "8010551055",
        "emailid": "support@cozyvision.com",
        "allowedprefix": "[\"91\"]",
        "parent_id": "32",
        "expirydate": "2020-12-04",
        "mobile_verified": 1,
        "kyc_status": 1,
        "android_push": 1,
        "two_factor_auth": 0
    }
}

Example Response

401 – Unauthorized 
{
    "status": "error",
    "description": "account expired."
}

Account

POST Register

https://www.smsalert.co.in/users/add.json?rtype=self

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

200 – OK 
{
    "status": "success",
    "description": "added successfully."
}

Account

POST Forgot Password

https://www.smsalert.co.in/users/forgotpassword.json

Headers

Content-Type

application/x-www-form-urlencoded

Body urlencoded

data[User][username_email]

shanky@cozyvision.com

Registered Mail Id

Example Request

Example Response

200 – OK 
{
    "msg": "Password reset link has been sent to your email address. You have 24 hours to complete the request.",
    "status": "success"
}

Example Response

200 – OK 
{
    "msg": "Sorry, the username entered was not found.",
    "status": "failed"
}

Account

POST Change Password

https://www.smsalert.co.in/api/changepwd.json

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

200 – OK 
{
    "status": "success",
    "description": "Password Changed Successfully"
}

Account

POST Update Profile

https://www.smsalert.co.in/api/updateprofile.json?apikey=5e0741771f08e&firstname=Cozy&lastname=Vision&mobilenumber=8010551055&emailid=support@cozyvision.com&fcm_id=6464646

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

200 – OK 
{
    "status": "success",
    "description": "Profile Updated Successfully"
}

Example Response

401 – Unauthorized 
{
    "status": "error",
    "description": "invalid api key"
}

Example Response

200 – OK 
{
    "status": "error",
    "description": {
        "emailid": [
            "Email is not valid."
        ]
    }
}

Account

GET Balance Check API

https://www.smsalert.co.in/api/creditstatus.json?apikey=5dd7cd37e7239

params

apikey

5dd7cd37e7239

API Key generated from your SMS account

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "transactional:85-nondnd:5",
        "routes": [
            {
                "route": "transactional",
                "display_name": "Transactional",
                "credits": "85"
            },
            {
                "route": "nondnd",
                "display_name": "NON DND",
                "credits": "5"
            }
        ]
    }
}

Example Response

401 – Unauthorized 
{
    "status": "error",
    "description": "invalid username/password."
}

Account

GET Get Available Sender Id List

http://www.smsalert.co.in/api/senderlist.json?apikey=5dd7cd37e7239

params

apikey

5dd7cd37e7239

API Key generated from your SMS account

Example Request

Example Response

200 – OK 
{
    "status": "error",
    "description": {
        "desc": "no senderid available for your account"
    }
}

Example Response

200 – OK 
{
    "status": "success",
    "description": [
        {
            "Senderid": {
                "sender": "TESTIN",
                "approved": true,
                "open": true,
                "datetime": "2019-11-23 16:20:21"
            }
        }
    ]
}

Group

GET Get Group List

http://smsalert.co.in/api/grouplist.json?apikey=5e0741771f08e&limit=10&page=1&q=&order=desc

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

200 – OK 
{
    "status": "success",
    "description": [
        {
            "Group": {
                "id": "2230",
                "name": "Test1",
                "creationdate": "2019-11-25 10:25:48",
                "group_data": null,
                "groupfields": null,
                "members": "4"
            }
        },
        {
            "Group": {
                "id": "2225",
                "name": "Third",
                "creationdate": "2019-11-22 17:29:15",
                "group_data": "{\"duplicacy_allowed\":\"0\"}",
                "groupfields": null,
                "members": "1"
            }
        },
        {
            "Group": {
                "id": "2224",
                "name": "Second",
                "creationdate": "2019-11-22 17:29:08",
                "group_data": "{\"duplicacy_allowed\":\"0\"}",
                "groupfields": null,
                "members": "0"
            }
        },
        {
            "Group": {
                "id": "2223",
                "name": "First",
                "creationdate": "2019-11-22 17:29:00",
                "group_data": "{\"duplicacy_allowed\":\"0\"}",
                "groupfields": null,
                "members": "0"
            }
        }
    ]
}

Example Response

200 – OK 
{
    "status": "error",
    "description": {
        "desc": "no groups available for your account"
    }
}

Group

POST Create Group

http://www.smsalert.co.in/api/creategroup.json?apikey=5dd7cd37e7239&name=CozyTest

params

apikey

5dd7cd37e7239

API Key generated from your SMS account

name

Cozy Test

Group Name, that you wish to create

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": "group created successfully."
}

Example Response

200 – OK 
{
    "status": "error",
    "description": {
        "desc": "Group already exists"
    }
}

Example Response

200 – OK 
{
    "status": "error",
    "description": {
        "desc": "Only Alphabets, numbers, hyphen, underscore allowed. Space not allowed"
    }
}

Group

POST Delete Group

https://www.smsalert.co.in/api/deletegroup.json?apikey=5dd7cd37e7239&id=2227

params

apikey

5dd7cd37e7239

API Key generated from your SMS account

id

2227

Group Id

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": "group deleted"
}

Group

POST Edit Group

https://www.smsalert.co.in/api/updategroup.json?apikey=5dd7cd37e7239&id=2227&name=Hello

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