Hoiio Open API logo Hoiio Open API

Hoiio API is designed somewhat RESTful and is available over HTTPS for secure requests and responses. For more information on REST, you may take a look at https://en.wikipedia.org/wiki/Representational_State_Transfer. We support the use of 2 HTTP verbs for all requests: GET and POST. You may use them interchangeably for all of the endpoints.

The API provides a set of endpoints to developers which allow them to interact with telephony services such as SMS and voice calls. Some examples of endpoints available are:

Request – application/x-www-form-urlencoded

The values of the arguments sent in requests should be URL-encoded. To learn about URL-encoding, you may take a look at https://en.wikipedia.org/wiki/Percent-encoding. For example,

+6512345678

gets encoded to

%2B6512345678

An example format of application/x-www-form-urlencoded:

dest=%2B6512345678&app_id=1234567890abcdef&access_token=1234567890abcdef&msg=hello+world

Response – JSON

Responses to API requests are encoded in JSON format. For more information on JSON, you may take a look https://www.json.org/. An example of JSON formatted response is:

{
    "status":"success_ok",
    "entries_count":"2",
    "entries":[
        {
            "date":"2010-01-01 10:10:00",
            "duration":"7",
            "dest1":"+6511111111",
            "dest2":"+6522222222",
            "currency":"SGD",
            "rate":"0.020",
            "debit":"0.140"
        },
        {
            "date":"2010-01-01 16:10:00",
            "duration":"1",
            "dest1":"+6511111111",
            "dest2":"+6533333333",
            "currency":"SGD",
            "rate":"0.020",
            "debit":"0.040"
        }
    ]
}