API Structure

Bitel APIs are designed based on RESTful standard, meaning that requests and responses are in JSON format.

The general format of HTTP response

{
    "result": T,
    "error": "Error message"
}

The response always contains a "result" and an "error", in case the status code is OK(200) the "error" is always null and if the status code is 3xx or 4xx the error always contains an error code.

Success Response Example

{
    "result": {
        "requestId": "1bd0a75c548dff824344"
    },
    "error": null
}

Error Response Example

{
    "result": null,
    "error": "InvalidPhoneNumber"
}

The error code for each API is described in its own dedicated page, while the global errors are listed in General API Errors page.