Hoiio Open API logo Hoiio Open API




app_id string
Application ID assigned to your application.
access_token string
Access Token assigned to your application.

Result Format

    "name":"John Doe",
    "caller_ids":["+6511111111", "p"],


This API retrieves the current credit balance of your account.

Response Parameters

status The result of your request. Refer to Result Status for details.
uid The user id of your account.
name The full name of your account.
mobile_number The registered number of your account. Phone numbers start with a "+" and country code (E.164 format), e.g. +6511111111.
caller_ids The list of caller ids you can use consisting of:
  • Your registered number
  • Your Hoiio Number
  • "private"
email The email address of your account. This is present only if the email address is verified.
country The country of your account in ISO 3166-1 alpha-2 format (e.g. SG).
prefix The country code prefix of your account (e.g. +65)
currency Currency used for this account. Refer to Currency Code for the list of currency code.
time_zone Timezone used for this account. The timezone will be shown in as a timezone offset from Greenwich Mean Time, in accordance with ISO 8601. e.g. GMT+0800SG
user_status Current status of your account. The account can be in the following states:
  • trial
  • active
Please refer this page for a feature comparison of Trial and Active accounts.
sms_rebrand_status The SMS Rebranding Status of this account. Refer to Sender Rebranding for more info.The rebranding status can be in the following states:
  • enabled
  • disabled
call_rebrand_status The Call Rebranding Status of this account. The rebranding status can be in the following states:
  • enabled
  • disabled

Result Status

success_ok The request has been processed successfully.
error_invalid_http_method Invalid HTTP method. Only GET or POST are allowed.
error_malformed_params HTTP POST request parameters contains non-readable bytes.
error_X_param_missing A required parameter is missing. X is the name of the parameter that is missing.
error_invalid_access_token Your Access Token is invalid, expired or has been revoked.
error_invalid_app_id Your Application ID is invalid or has been revoked.
error_rate_limit_exceeded You have exceeded your request limit for this API. Refer to API Limits for details.
error_internal_server_error There is an unexpected error. Please contact Hoiio support for assistance.



API Limits

3 request per minute per application