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.
dest* string
The recipient number of the fax. Phone numbers should start with a "+" and country code (E.164 format), e.g. +6511111111. This parameter cannot be both present with the incoming parameter below.
incoming* string
Your Hoiio number to receive incoming fax. This parameter cannot be both present with the dest parameter above.

Result Format



This API retrieves the billable rate that will be charged for fax sent or received via the fax/send API and fax/receive API respectively.

Response Parameters

status The result of your request. Refer to Result Status for details.
currency Currency used for this transaction. Refer to Currency Code for the list of currency code.
rate Billable per-minute rate.

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_dest_invalid dest parameter is invalid.
error_dest_incoming_both_present dest parameter and incoming are both present.
error_dest_incoming_both_missing dest parameter and incoming are both missing.
error_service_not_available The fax service is currently not available to the destination you specified. Do check at our Pricing Page to see the destinations supported.
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

60 request per minute per application