gethttp://api-conserver.onlinesim.io/stubs/handler_api.php?action=getBalance

GET /stubs/handler_api.php?action=getBalance

Get information on current user balance

Returns the current user balance.

You call this method to check the balance of the profile to top it up when needed or to handle WARNING_LOW_BALANCE exceptions.

Security

api_key
BearerAuth
OAuth2Scopes: sms-scope, rent-scope
sms-scope
grants access to manage numbers for the SMS receiving service from Onlinesim
rent-scope
grants access to renting phone numbers from Onlinesim

Parameters

query1
NameTypeDescription
action*string

Method name, in this case getBalance

Enum:getBalanceDefault:getBalance

Responses

200

Successful getBalance response from the server: either returns your profile''s current available balance or throws an exception.

Content-Typetext/html
Schema
Responsestring

Examples

getBalance example response
ACCESS_BALANCE:530.82

Code Samples

Generating examples...