Contents | Search

Home

• Product Manual
• Introduction
• SMS technology
• Installation Guide
• User Guide
• Developers Guide
• Tutorials
• ASP SMS API
• PHP SMS API
• HTTP SMS API
• Send message
• Receive message
• Billing methods
• getcredits
• setcredits
• addcredits
• Urlencode
• Select operator
• Operate with single message
• Query the addressbook
• Operations with message folders
• Examples
• User handling
• Service Provider Connection Handling
• Reporting API
• Dynamic SMPP parameters
• SQL SMS API
• C Sharp SMS API
• AJAX SMS API
• Delphi SMS API
• Cpp SMS API
• Java SMS API
• VB.NET SMS API
• Python SMS API
• Perl SMS API
• TCL/TK SMS API
• Coldfusion SMS API
• VB 6 SMS API
• Examples and Solutions
• Appendix
• FAQ
• Feature list
• Commercial Information
• Search

HTTP SMS API - getcredits

This method can be used to get information about how many messages can a user send. The credit limit of the user is modified if a cost is defined for a route. This way the system can be setup to charge the user for both incoming and outgoing messages. It is also possible to set negative costs for various routes, which is a good option for premium rated services. Negative costs can increase the balance of a user.

Example URL Request

Example Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 824

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml">
<response>
   <action>getcredits</action>
   <data>
      <account>
         <username>admin</username>
         <balance>123</balance>
      </account>
   </data>
</response>

Description

To get information about the balance of a useraccount use the following format:

http://127.0.0.1:9501/api?action=getcredits&username=UUUUU&password=PPPPP&useraccount=AAAAA

For 127.0.0.1, you should substitute the host name or the IP address of the computer your SMS gateway is installed on. The port number 9501 is the default HTTP port number of the Ozeki NG SMS gateway. It is should not be changed.

The username and the password should be substituted for "UUUUU" and "PPPPP". The username and password identifies the user who wants to get information about the balance. AAAAA should be substituted for the username that specifies the account you want to query information about. For example if the admin user would like to find out what is the balance of a user called "john", he would substitute "admin" for "UUUUU", "abc123" for "PPPPP", which is the username and password of the admin account, then he would substitute "john" for AAAAA. In this case the request would look like this:

http://127.0.0.1:9501/api?action=getcredits&username=admin&password=abc123&useraccount=john

The admin user can query information about all accounts in the system. A user without administrative privileges can query information about his account only. The useraccount parameter is optional. If it is not specified, information will be returned from the account of the logged in user.

Request parameters

Response parameters
(xml response format)

 <account>
         <username>admin</username>
         <balance>123</balance>
      </account>