17/06/2022, 20:21 | Web SMS Panel
Developer Documentation
We provide you the complete convenience in applying APIs. But if you still have
trouble with APIs integration then please mail us. We wish you a better service..
Send SMS API Section
HTTP API Specification With API-Key
Once downloaded, unzip the compressed folder and you’ll see something like this:
<!Below API for Send SMS>
http://136.243.76.205/vb/apikey.php?apikey=XXXXXXXXXXXXXXXXXXXX&senderid=XX
Unicode or Schedule SMS API With API-Key or Without API-Key
Use optional Parameter, unicode=2. And schedule, time=your schedule time. time
format(yyyy-mm-dd hh:MMSS) like: time=2017-02-17 04:00pm
Call Back Short URL
Use optional Parameter, short_url=call back url. eg: short_url=google.com
Mandatory Parameters
Name Parameter Description Expected Values
API Key apikey API key generated from your SMS key generated from your
Account. Not required in normal API. account
Sender ID senderid Sender ID assigned to your account Sender ID 6 Character only
allow
DLT templateid Operators have shared that template Share DLT Registered
Template- scrubbing will be live from April 1st, Template-ID
ID 2021. Please register all necessary
templates in DLT platforms. Or related
query contact to support team.
136.243.76.205/Dashboard.php?page=apicode 1/5
17/06/2022, 20:21 | Web SMS Panel
Mobile number Mobile number to which the SMS is to Mobile number like
number be sent.The destination mobile 91XXXXXXXXX OR
number can be with or without 91. 98908XXXXX OR
Also provide multiple numbers in 91XXXXXXXXX,98908XXXXX
comma separated format.
Message message Message to be sent Message text which is URL
encoded(Max 1000 char for
normal, 500 for unicode)
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
Name Parameter Description Expected Values
unicode unicode To specify that the 2
message to be sent is in
unicode format.
Schedule time Date and time for EX Format: YYYY-MM-DD HH:MM:SS OR
time scheduling an SMS YYYY-MM-DD HH:MM AM/PM Like : 2016-
12-06 04:45pm
Call Back short_url Conversation tracking short_url=selected url
Short URL with short url
Response format Output format should be PHP/JSON. Default response will be in
Type as specified by this JSON
variable.
API Error Codes
The common error codes received while using the API to send an SMS is in the below format :
Error Code Status Description
001 false Kindly provide apikey
002 false Invalid route-Id
004 false No Message Found!
005 false Schedule Date/time can't less than current time!
006 false Invalid Date Time Format!
007 false No numbers found!
008 false You have insufficient credit!
009 false Parent has Less Balance!
010 false Message campaign failed!
011 Success Message submitted successfully
Success Reponse Data
Success response is in the below format :
status It indicates the success or failure of your request.
code success response code 011.
136.243.76.205/Dashboard.php?page=apicode 2/5
17/06/2022, 20:21 | Web SMS Panel
data response is wrapped inside data
messageid message compaign id.
totnumber total numbers of sms
totalcredit tot sms credit
Example of Send SMS Response:
JSON PHP Error Example
{
"status": "Success",
"code": "011",
"description": "Message submitted successfully",
"data":
{
"messageid": "",
"totnumber": "3",
"totalcredit": "3"
}
}
DLR Response API
<!Below API for delivery report>
http://136.243.76.205/vb/http-dlr.php?apikey=XXXXXXXXXXXXXXXX&msgid=XXXXXXX
API Error Codes
The common error codes received while using the API to get dlr report is in the below format :
Error Code Status Description
001 false Kindly provide valid apikey
002 false Invalid user OR user is deactivated
003 false Kindly provide valid message id
Example of DLR Response:
JSON PHP Error Example
136.243.76.205/Dashboard.php?page=apicode 3/5
17/06/2022, 20:21 | Web SMS Panel
{
"status": "Success",
"code": "004",
"totRecord": "3",
"data": [
{
"id": "MzQz",
"mobile": "XXXXXXXXXX",
"status": "delivered",
"delvd_time": "01-01-2019 23:59:58",
},
{
"id": "MzQz",
"mobile": "XXXXXXXXXX",
"status": "delivered",
"delvd_time": "01-01-2019 23:59:59",
},
{
"id": "MzQz",
"mobile": "XXXXXXXXXX",
"status": "submitted",
"delvd_time": "---",
}
]
}
Check Balance API
http://136.243.76.205/vb/http-credit.php?apikey=XXXXXXXXXXXXXXXX&route_id=X
API Error Codes
The common error codes received while using the API to get dlr report is in the below format :
Error Code Status Description
001 false Kindly provide valid apikey
002 false Kindly provide valid route ID
Example of Credit API Response:
JSON PHP Error Example
{
"status": "Success",
"code": "003",
"balance": "500000"
}
Example of API Integration:
Below source code of push API.
136.243.76.205/Dashboard.php?page=apicode 4/5
17/06/2022, 20:21 | Web SMS Panel
<!Below code in php.>
$key = "XXXXXXXXXXXXXXXXXXXX";
$mbl="XXXXXXXXXX"; /*or $mbl="XXXXXXXXXX,XXXXXXXXXX";*/
$message_content=urlencode("hello there");
$senderid="XXXXXX"; $route= 1;
$templateid="XXXXXX";
$url = "http://136.243.76.205/vb/apikey.php?apikey=$key&senderid=$senderid
$output = file_get_contents($url); /*default function for push any url*/
Thank You!
Copyright © 2022 . All rights reserved.
136.243.76.205/Dashboard.php?page=apicode 5/5
