You are on page 1of 7

OnHandSMS API

V2 API Details

Retrieve Accounts 2
Request: 2
Response: 2

Sender Ids 3
Request: 3
Response: 3

Update Password 4
Request: 4
Response: 4

SMS Quota 5
Request: 5
Response: 5

SendSMS 6
Request: 6
Response: 6

Copyright Agaram Solutions


Retrieve Accounts


http://api.onhandsms.com/api/v2/accounts?username=​
<<username>>&password=​<<password
>>

Request:

Method accounts

Parameter Name Parameter Description

username This will contain the username of the user

password This will contain the password of the user

Response:

Status Sample Response

Success {
"status":true,
"properties":[{"company_name":"AS","is_email_active":"N","is_sms
_active":"Y"}]
}

Failed {
"status":false,
"error":"Invalid username/password"
}

Copyright Agaram Solutions


Sender Ids

http://api.onhandsms.com/api/v2/senderid?username=​<<username>>&password=​<<password>
>

Request:

Method senderid

Parameter Name Parameter Description

username This will contain the username of the user

password This will contain the password of the user

Response:

Status Sample Response

Success {
"status":true,
"properties":[{"type":"T","sender_id":"AGARAM"}]
}

Failed {
"status":false,
"error":"Invalid username/password"
}

Copyright Agaram Solutions


Update Password

http://api.onhandsms.com/api/v2/changepwd?username=​<<username>>&password=​<<passwo
rd>>&new_password=​<<new_password>>

Request:

Method changepwd

Parameter Name Parameter Description

username This will contain the username of the user

password This will contain the password of the user

new_password New Password

Response:

Status Sample Response

Success {
"status":true
}

Failed {
"status":false,
"error":"Invalid username/password"
}

Failed {
"status":false,
"error":"New and old password are same"
}

Copyright Agaram Solutions


SMS Quota

http://api.onhandsms.com/api/v2/smsquota?username=​<<username>>&password=​<<password
>>

Request:

Method smsquota

Parameter Name Parameter Description

username This will contain the username of the user

password This will contain the password of the user

Response:

Status Sample Response

Success {
"status":true,
"properties":[{"total_sms_quota":"50","used_sms_quota":"23"}]
}

Failed {
"status":false,
"error":"Invalid username/password"
}

Failed {
"status":false,
"error":"No Data Found"
}

Failed {
"status":false,
"error":"Sender ID Required"
}

Copyright Agaram Solutions


SendSMS

http://api.onhandsms.com/api/v2/sendsms?username=​<<username>>&password=​<<password
>>&senderid=​<<senderid>>&message=​<<message>>&number=​<<number>>&istamil=​<<0or1>
>

Request:

Method sendsms

Parameter Name Parameter Description

username This will contain the username of the user

password This will contain the password of the user

senderid SMS SenderId

Message Message

number Destination Number.

istamil 0 (or) 1

Response:

Status Sample Response

Success {
"status": true,
"properties": "S.398041 "
}

Failed {
"status":false,
"error":"Invalid username/password"
}

Failed {

Copyright Agaram Solutions


"status":false,
"error":"<br>Sender ID Does not Exist or Pending or Route Invalid!"
}

Failed {
"status":false,
"error":"Sender ID Required"
}

Copyright Agaram Solutions