OZEKI
NG SMS Gateway
"The World's most reliable SMS gateway software!"
info@ozekisms.com
Tel.: 00 36 52 532 731
Overview Quick start Download Manual How to buy FAQ Contact Us
OZEKI NG SMS Gateway - Product Guide

getcredits Contents | Searchaddcredits

Home > Product Manual > Developers Guide > HTTP SMS API > Billing methods > setcredits

SMS Gateway SMS Gateway 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
 


Automated phone calls?
Ozeki Phone System XE VoIP PBX software is an advanced PBX built for automated voice calls and 2 way SMS messaging. It has outstanding APIs for software developers. It can be used for:

Phone calls from SQL
Phone calls from HTTP
Voice and SMS applications

Callcenter developers
If you are working on telephone solutions, please check out the Ozeki VoIP SIP SDK.
It can be used to create VoIP client and server software.

Contact Us!
If you wish to get further information, do not hesitate to contact us!

E-mail: info@ozekisms.com

If you have a technical question, please submit a support request on-line.

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

Parameter Description Possible values Example M/O*
action Specifies the HTTP API command setcredits action=setcredits M
username This should be set to "admin", since only the admin account can update credit information in the server. string value, maximum length is 16 characters username=admin M
password This should be set to the "password" of admin, since only the admin account can update credit information in the server. The password should be urlencoced. string value, maximum length is 16 characters password=abc123 M
useraccount Specifies the name of the user account, whose balance is going to be changed. If this parameter is not specified, the balance of the admin account will be changed. string value, maximum length is 16 characters useraccount=john O
newbalance Specifies the new balance. The balance of the user account identified by the useraccount parameter will be changed to this value. If this parameter is not specified, the balance of the user account will not be changed. int value newbalance=500 M

* M = Mandatory parameter, O = Optional parameter

Response parameters
(xml response format)

Parameter Description Possible values Example
account Contains the balance of a user account in an XML structure  
 <account>
   <username>admin</username>
   <balance>123</balance>
</account>
account.username Identifies the user account. string value, maximum length is 16 characters <username>admin</username>
account.balance Contains the balance of the user account after the change. If this value is less then or equal to zero, the user cannot send SMS messages. integer value <balance>123</balance>




Next page: addcredits
Copyright © 2000 - 2014 Ozeki Informatics Ltd.
All rights reserved

Software PBX for Windows | VoIP SDK   |   Legal information   |   Privacy policy   |   Terms of use
Please, address your inquiries to info@ozekisms.com