Skip to content


Here you will find description of VoIPstudio API, which gives access to all platform resources.


The REST API enables VoIPstudio customers to access a wide range of resources. Our API has predictable, resource-orientated URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features like HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application. JSON is returned by all API responses, including errors.


The base URL for the API is:


Before sending requests to VoIPstudio API you first need to obtain API Key also known as user_token which will be used to authorise all requests.

You can generate API Key / user_token in of the following two ways:

  1. Send POST request to /login endpoint with email and password as credentials.
  2. Use VoIPstudio Web Dashboard to create API Key / user_token.

Please see detailed instructions below:

Login with email and password

Login request using e-mail and password:

curl -X POST -H "Content-Type: application/json" \ \
     -d '{"email":"","password":"$ecretPas$$"}'

Example request:

POST /v1.2/voipstudio/login HTTP/1.1
Content-Type: application/json

Example of successful response:

    "message":"Login success",

By default user_token will expire after 30 minutes of inactivity (ie. no API requests are made). Every time an API request is made expiration timer is reset.

If you require API tokens with longer expiration time, after obtaining initial user_token with POST /login request, additional API keys can be created by sending POST /apitokens:

curl -X POST -H "Content-Type: application/json" \
     -H "X-Auth-Token: 123456abc993ba5dd8a0e7ce9876543" \ \
     -d '{"name":"Example API App","expiry":604800}'

Example of successful response:

        "name":"Example API App",
        "created_at":"2023-02-09 17:20:01"

Note: to create API Key which will never expire, use "expiry":0 in request payload to POST /apitokens

Web Dashboard - Add API Key

Follow steps below to add API Key for a user:

  1. In Administration panel edit user for whom API Keys needs to be added.
  2. Go to API Keys section.
  3. Enter a name for your API Key, this can be anything you like. For example a name of your application that will use this API Key.
  4. Click "Add" button.
  5. Click "Eye" icon to retrieve the actual API Key / user_token
  6. Click "Gear" icon and select "Show Details" to obtain additional details or delete API Key.


Figure 1.1 Add API Key.

Making requests

Incoming requests handled by our API are expected to have a X-Auth-Token header with a value user_token (API Key) returned from a successful POST /login or POST /apitokens response.

X-Auth-Token: TOKEN

Example of authenticated request:

curl -H "Content-Type: application/json"
     -H "X-Auth-Token: 123abc45678def3234sdfgdf3434df3444" \

HTTP responses

VoIPstudio REST API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that has failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate a server error.

Each successful response, depending on HTTP method, contains the following properties:

  • GET collection of resources:

    • data - an array of resources data
    • total - total number of resources
  • GET single resource:

    • data - resources data
    • links - links to related resources

Each error response contains the following properties:

  • message - general error message
  • errors - an array of error messages


For data collection endpoints such as GET pager can be used to return a specific number of records from a given page in the data set. To apply pager please append the following parameters to the URL ?page=N&limit=Z where N is a page number and Z is the number of records to be returned (maximum 5000).


To filter data, the filter parameter can be passed as a URL query string. The value of filter parameter has to be JSON encoded string in the format shown below:


The three tokens above _PROPERTY_NAME_, _OPERATOR_ and _VALUE_TO_SEARCH_ should be interpreted as below:

  • _PROPERTY_NAME_ this can be any property that belongs to particular endpoint object. See "Resources" section below for detailed explanation of data model for each endpoint.

  • _OPERATOR_ can be one of:

    • eq or = when looking for records with "property" value equal to _SEARCH_VALUE_
    • ne, neq, <> or != when looking for records with "property" value NOT equal to _SEARCH_VALUE_
    • lt or < when looking for records with "property" value less than _SEARCH_VALUE_
    • lte or <= when looking for records with "property" value less than or equal _SEARCH_VALUE_
    • gt or > when looking for records with "property" value greater than _SEARCH_VALUE_
    • gte or >= when looking for records with "property" value greater than or equal _SEARCH_VALUE_
    • in when looking for records with "property" value included in _SEARCH_VALUE_ (Note: search value needs to be passed as an array, eg: [ "foo", "bar" ])
    • like when looking for records with "property" value matching pattern of _SEARCH_VALUE_
    • notlike when looking for records with "property" value NOT matching pattern of _SEARCH_VALUE_
  • _SEARCH_VALUE_ the value you want to search for

Example of request to /cdrs endpoint searching for incoming calls (dst_id property equals user Id) to user Id 123456 after 1st Sep. 2018:

curl -G -H "X-Auth-Token: TOKEN" '' \
     --data-urlencode 'filter=[
       {"property":"calldate","operator":"gt","value":"2018-09-01 00:00:00"}


group_by parameter is available for grouping records by specific property: GET This parameter should be passed as URL query string.