in Platform

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.

OTP

POST Generate OTP

https://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateloginotp&mobileno=8010551055

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

generateloginotp

Action

mobileno

8010551055

Shopify customer register number

Example Request

Example Response

200 – OK 
{
    "status": "error",
    "description": "Sorry, but you do not have a registered phone number"
}

Example Response

200 – OK 
{
    "status": "error",
    "description": "Sorry, your account is not active, please contact to site admin."
}

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "1 messages scheduled for delievery",
        "batchid": "34163609",
        "batch_dtl": [
            {
                "mobileno": "8010551055",
                "msgid": "10823108",
                "status": "AWAITED-DLR"
            }
        ]
    }
}

OTP

POST Generate Register OTP

https://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateregotp&mobileno=8010551055&emailid=smsalert123%40gmail.com

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

generateregotp

Action

mobileno

8010551055

mobile number

emailid

smsalert123@gmail.com

Email id

Example Request

Example Response

200 – OK 
{
    "status": "error",
    "description": "This mobile number is already registered, please login."
}

Example Response

200 – OK 
{
    "status": "error",
    "description": "This email is already registered, please login."
}

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "1 messages scheduled for delievery",
        "batchid": "34163609",
        "batch_dtl": [
            {
                "mobileno": "8010551055",
                "msgid": "10823108",
                "status": "AWAITED-DLR"
            }
        ]
    }
}

OTP

POST Validate OTP

http://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateloginotp&mobileno=8010551055&mobileno=8010551055&code=3167

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

validateloginotp

Action

mobileno

8010551055

Mobile number

otp

3167

OTP entered by the user

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "Code does not match."
    }
}

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "Code Matched successfully."
    },
	"response_code":200,
	"data":{"email":"smsalert@gmail.com","password":"123456"}
}

OTP

POST Validate OTP

http://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&customer%5Bemail%5D=smsalert123adasf%40gmail.com&customer%5Bpassword%5D=123456&customer%5Bphone%5D=8010551045&action=validateregotp&mobileno=8010551045&otp=7971

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

validateregotp

Action

mobileno

8010551055

Mobile number

customer[email]

smsalert@gmail.com

Customer emailid

customer[phone]

8010551055

Customer phone

customer[password]

123456

Customer password

otp

3167

OTP entered by the user

Example Request

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "Code does not match."
    }
}

Example Response

200 – OK 
{
    "status": "success",
    "description": {
        "desc": "Code Matched successfully."
    },
	"response_code":200,
	"data":{"email":"smsalert@gmail.com","password":"123456"}
}

0

Still can't find the solution for your Query?

Contact Support