HTTP SMS API - setcredits

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

This method can be used to modify the balance of a user account. The credit limit of a user account specifies how many messages the user can send and receive. You can use the setcredits method to set the balance to a specific value.

Example URL Request

http://127.0.0.1:9501/api?action=setcredits&username=admin&password=abc123&useraccount=admin&newbalance=500

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>setcredits</action>
   <data>
      <account>
         <username>admin</username>
         <balance>500</balance>
      </account>
   </data>
</response>

Description

To modify the credit limit of a user account use the following URL format:

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

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.

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 is about to be updated, should be substituted for AAAAA. The new balance should be specified in the newbalance parameter (BBBBB).

If the newbalance parameter is left empty the balance will not be modified.

Request parameters

Response parameters
(xml response format)

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