API Documentation
Api For Single SMS
GET http://sms.biztoll.com/api/sendhttp.php?authkey=ZTBmZjFmNzUwNjB&mobiles=Mobile1&message=Your Message&sender=Sender Id&type=type&route=route
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| mobiles | 9876543210 | Mobile Number 0 or 91 |
| message | You Text Message | Message you wish to send |
| sander | Sender ID | Eg: RNDSMS |
| type | type | "1" for Normal | "2" Unicode |
| route | route | "1" for Promotional | "2" for Transactional | "3" for Promo-SenderId |
Responses
| Key | parameter | Description |
|---|---|---|
| error | error | error can be null , Invalid API Key! , Invalid SenderId , Invalid API Key , Invalid Route ,Invalid Type, credits unavailable |
| msg_id | [msg_id] | msg_id : if error , then value will be null else message id (can be used to track status) credits: available credits |
| credits | credits | not enough credits or no credits |
Api For Multiple SMS
GET http://sms.biztoll.com/api/sendhttp.php?authkey=ZTBmZjFmNzUwNjB&mobiles=Mobile1,Mobile2,Mobile3,...&message=Your Message&sender=Sender Id&type=type&route=route
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| mobiles | 9876543210 | Mobile Number 0 or 91 |
| message | You Text Message | Message you wish to send |
| sander | Sender ID | Eg: RNDSMS |
| type | type | "1" for Normal | "2" Unicode |
| route | route | "1" for Promotional | "2" for Transactional | "3" for Promo-SenderId< |
Responses
| Key | parameter | Description |
|---|---|---|
| error | error | error can be null , Invalid API Key! , Invalid SenderId , Invalid API Key , Invalid Route ,Invalid Type, credits unavailable |
| msg_id | [msg_id] | msg_id : if error , then value will be null else message id (can be used to track status) credits: available credits |
| credits | credits | not enough credits or no credits |
API TO CHECK CREDITS
GET http://sms.biztoll.com/api/checkcredits.php?authkey=ZTBmZjFmNzUwNjB
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| error | error | error can be null Or Invalid API Key |
| promo_credits | promo_credits | available promotional credits |
| trans_credits | trans_credits | available transaction credits |
API TO LIST ALL SENDERIDS
GET http://sms.biztoll.com/api/getsenderids.php?authkey=ZTBmZjFmNzUwNjB
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| sender_ids | [{"name":"SENDERID1","status":"1"},{"name":"SENDERID2","status":"0"},..] } | Pull up the list of approved Sender ID's |
| status | status | 0 means inactive and 1 means active |
| name | Sender ID Name | Sender ID Name |
| type | type | "1" for Normal | "2" Unicode |
| route | route | "1" for Promotional | "2" for Transactional | "3" for Promo-SenderId< |
Responses
| Key | parameter | Description |
|---|---|---|
| error | error | error can be null , Invalid API Key! , Invalid SenderId , Invalid API Key , Invalid Route ,Invalid Type, credits unavailable |
API TO REQUEST SENDER ID
GET http://sms.biztoll.com/api/req_sender_ids.php
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| sender_ids | Sender ID Name | Name of the Sender ID | route | route | "1" for Promotional | "2" for Transactional |
Responses
| Key | parameter | Description |
|---|---|---|
| error | error | error can be null , Invalid API Key Or Invalid Route |
| is_created | 1 | 0 | 1 means created successfully and 0 means failed to create sender id |
API TO Get Status
GET http://sms.biztoll.com/api/reports.php?authkey=ZTBmZjFmNzUwNjB&msg_id=id
| Key | parameter | Description |
|---|---|---|
| authkey | ZTBmZjFmNzUwNjB | Login authentication key (this key is unique for every user) |
| msg_id | id | message 'id' which was returned by sendhttp api . |
Responses
| Key | parameter | Description |
|---|---|---|
| error | error | error can be null , Invalid API Key Or Invalid Route |
| status | 1 | 0 | 1 means sent successfully and 0 means failed |