HTTP SMS API - addcredits

(available in version: Ozeki NG SMS Gateway v3.0.1 or newer)

This method can be used to add or deduct credits from the balance of a user. The credit limit of a user specifies how many messages the user can send and receive. If you use want to increase or decrease the balance, use this method. This method is better then the setcredits method if you want to do a relative change in the balance, because you don't have to worry about messages being sent in the time between your query and your update of the current balance.

Example URL Request

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

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>john</username>
         <balance>744</balance>
      </account>
   </data>
</response>

Description

To add credits to the balance of a user account use the following URL format:

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

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 Ozeki NG SMS gateway.

The username and the password of the admin account should be substituted for "UUUUU" and "PPPPP". No other users can modify the credit limits of an account. The username of the account whose balance will be changed, should be substituted for AAAAA. The amount you want to add should be put into VVVVV. If you want to take credits away, VVVVV should be a negative number.

Request parameters

Response parameters
(xml response format)

 <account>
         <username>john</username>
         <balance>744</balance>
      </account>