Ufone - Business SMS
Functions and parameters
for
Business SMS API-v-0.8
Ufone - Business SMS
Change Log:
Version Date Description
0.1 25-01-2009 HTTP API For sending SMS
0.2 02-07-2009 HTTP API For sending SMS
0.3 16-02-2010 XML Response with sent message ID
0.8 30-10-2018 Send messages on multiple
numbers with comma separated.
http protocol change into https
Ufone - Business SMS
1 Submitting Request for B-SMS API-v-0.3
1.1 API description:
To request for on, the Service Provider’s web server should make an Http request to
B-SMS API’s server in the following way:
https://<host>/bsms_v8_api /sendapi-
0.3.jsp?id=<msisdn>&message=<message>&shortcode=<short+code>&lang=<lan
guage>&mobilenum=<mobile+number>&password=<password>&messagetype=<
Nontransactional>
Example Below:
https://bsms.ufone.com/bsms_v8_api/sendapi-
0.3.jsp?id=03331234567&message=test&shortcode=B-
SMS&lang=English&mobilenum=92***********,92********&password=******&g
roupname=&messagetype=Nontransactional
Parameters Value Description
id 03331234567 A valid account ID for the customer
message Hello Text message to be sent
shortcode B-SMS SMS masking for the customer
Language is English. Not Case
lang English
sensitive
Any valid number to whom you
mobilenum 923331234567 want to send message starting with
92 and characters length 12.
password Test123 A valid password to request API.
Any valid group name to whom you
groupname Administrator
want to send message (optional).
Message Type Message can be use like,
Transactional/
transactional/ nontransactional
nontransactional
Multiple Number Ten numbers are allowed/number
923331234567,923****
must be in common separated
***
1.2 Transaction description:
When submitting a request to B-SMS API’s server, the SP’s web server will receive
back the following XML response (for example):
<response_to_browser>
<script type="text/javascript" charset="utf-8" id="zm-extension"/>
<response_id>0</response_id>
<response_text>Successful:12</response_text>
</response_to_browser>
<response_id></response_id> will have following expected values
Values
Ufone - Business SMS
0 Text message successfully sent.
1 Text message could not sent successfully.
<response_text></response_text> will have following expected values
o Successful: id
o Incomplete Parameters
o API Disabled
o Account Expired
o No Credit in Account
o Invalid Account ID
o Invalid Mobile No
o Invalid Sender IP
o Invalid Short code
o Invalid API Password
o Invalid Operator
o Special Characters in Message
o Unsuccessful
o Numbers of MSISDN Exceeded
Parameters
Text message successfully sent and id is sms
Successful: id
id.
Incomplete Parameters One of the required parameters is missing.
API Disabled API is disabled for this customer.
Account Expired Customer account has expired.
No Credit in Account No credit in account for the customer
Invalid Account ID Invalid account ID for the customer.
Invalid Mobile No Invalid recipient mobile number.
Invalid Sender IP Invalid IP address of the customer.
Invalid Short code Invalid SMS masking for the customer.
Invalid API Password Invalid API password for the customer.
Special Characters in Message Message contains special characters (`,#,&).
Unsuccessful An unexpected error has occurred.
Numbers of MSISDN Exceeded Ten numbers are allowed for Messages
10
