HotSpot API Commands and parameters

Description of commands and parameters for API integration in HotSpot software.

COMMAND: generateaccounts
Generates one or more accounts

[TXT] account : account (if 1) or account prefix (>1)
[NUM] number : number of accounts to generate
[NUM] groupplan : ID of the price plan or price group
[NUM] type : 0-prepaid, 1-postpaid, 2-ticket
[NUM] autologin : 0-disabled, 1-enabled
[NUM] inactivity : 0-disabled, 1-enabled
[NUM] sell : 0-status not sold, 1-status sold
[NUM] expire : number of days to expire from now
[NUM] timeleft : in seconds
[NUM] unltime : 0-disabled, 1-enabled
[NUM] quota : in bytes
[NUM] unlquota : 0-disabled, 1-enabled
[NUM] download : in bytes
[NUM] upload : in bytes
[NUM] print : 0-do not print, 1-print on paper
[NUM] preview : 0-no print preview, 1-print preview
[NUM] length : ticket length
[NUM] passlength : account password length
[TXT] password : optionally set password for account(s)
[NUM] startnumber : for manual account suffix numbering
__________________________________________________________

COMMAND: updateaccount
Updates account properties

[TXT] account : required field
[TXT] password : modify account password
[NUM] groupplan : ID of the price plan or price group
[NUM] type : 0-prepaid, 1-postpaid, 2-ticket
[NUM] printedcolor : number of printed pages
[NUM] printedbw : number of printed pages
[TXT] software : 1| for IC, 2| for HotSpot, etc.
[NUM] money : format 0.00
[NUM] moneyinc : increase money balance for value
[NUM] moneydec : decrease money balance for value
[NUM] timeleft : in seconds
[NUM] timeused : in seconds
[NUM] unltime : 0-disabled, 1-enabled
[NUM] unlquota : 0-disabled, 1-enabled
[NUM] quota : in bytes
[NUM] download : in bytes
[NUM] upload : in bytes
[NUM] autologin : 0-disabled, 1-enabled
[NUM] inactivity : 0-disabled, 1-enabled
[NUM] sell : 0-status not sold, 1-status sold
[NUM] enableexpire : 0-disabled, 1-enabled
[TXT] expiredate : in format YYYYMMDD
[TXT] expiredatetime : in format YYYYMMDDHHMM
[NUM] multilogins : number of simultaneous logins
[NUM] multilogin : 0-disabled, 1-enabled
[NUM] enabledailytime : 0-disabled, 1-enabled
[NUM] dailytime : in seconds
[NUM] dailytimeleft : in seconds
[NUM] enabledailyquota : 0-disabled, 1-enabled
[NUM] dailyquota : in bytes
[NUM] dailyquotaleft : in bytes

[TXT] firstname : customer first name
[TXT] lastname : customer last name
[TXT] address : customer address
[TXT] city : customer city
[TXT] postalcode : customer postal code
[TXT] state : customer state
[TXT] sex : customer gender M or F
[TXT] phone : customer phone
[TXT] mobile : customer mobile
[TXT] email : customer email
[TXT] email2 : customer email2
[TXT] docid : customer document ID
[NUM] doctype : 0-ID card, 1-passport, 2-drivers lic
[TXT] companyname : customer company name
[TXT] businessname : customer business name
[TXT] ccname : customer name of credit card
[NUM] cctype : 1-VISA 2-MASTER 3-DIS 4-AMEX…
[TXT] ccnumber : credit card number
[TXT] ccpassword : credit card password
[TXT] ccexpmonth : credit card expiration month
[TXT] ccexpyear : credit card expiration year
[TXT] cccvv2 : credit card CVV2
___________________________________________________________

COMMAND: refillaccount
Refills account with specified priceplan  or generates account if it does not exist

[TXT] account : required field
[NUM] priceplan : ID of the price plan
___________________________________________________________

COMMAND: viewaccount
Returns account details

[TXT] account : account for which to display details
___________________________________________________________

COMMAND: deleteaccount
Deletes specified account

[TXT] account : account to delete
_________________________________________________________

COMMAND: getpriceplans
Returns all generated priceplans
__________________________________________________________

COMMAND: getstatistics
Returns statitics for time period

[TXT] from : in format YYYYMMDD
[TXT] to : in format YYYYMMDD
__________________________________________________________

COMMAND: getaccountlog
Returns statitics for account sessions

[TXT] account : account for which to display details
[TXT] from : in format YYYYMMDD
[TXT] to : in format YYYYMMDD
__________________________________________________________

COMMAND: getaccountlist
Returns accounts list
__________________________________________________________

COMMAND: loginaccount
Login specified account

[TXT] account : account to login
[TXT] ip : ip address to login
[TXT] mac : mac to login
[NUM] time : in seconds
[NUM] unltime : 0-disabled, 1-enabled
[NUM] quota : in bytes
[NUM] unlquota : 0-disabled, 1-enabled
[NUM] download : in bytes
[NUM] upload : in bytes
[NUM] inactivity : 0-disabled, 1-enabled
[NUM] expire : number of days to expire from now
_________________________________________________________

COMMAND: logoutaccount
Logout specified account

[TXT] account : account to logout
[TXT] ip : ip address to logout
[TXT] mac : mac to logout

Note: You can use any parameter for logut
_________________________________________________________

COMMAND: getaccountsummary
Returns statistics for account

[TXT] account : account for which to display details
[TXT] from : in format YYYYMMDD
[TXT] to : in format YYYYMMDD

Note: from and to parameters are optional

 

Updated on October 11, 2022

Was this article helpful?