Skip to main content

Data Models

For the impatient

You may explore this data model via the API Playground, by clicking here

The following documents describe each of the Cloudonix Voice API data models and the API endpoint that may be used to access and manipulate them.

info

  • Tokens enclosed by curly brackets ({ }) are to be replaced with an actual identifier (or the word self, as described above)

  • Tokens enclosed by square brackets ([ ]) mean an optional element, usually to mean a possible identifier to access a specific element, or omitting an identifier to access the list of elements.

The API Endpoint​

A Voice API Endpoint may contain identifying elements to allow addressing model objects in a canonical way based on their ownership. To illustrate this, observe the following relationship diagram:

The above diagram, will then translate to the following Voice API endpoint canonical URL:

/tenants/{customer}/domains/{domain}/subscribers/{subscriber}

Example​

Let us assume the following data:

customer/tenantdomainsubscriber
cloudonixcloudonix.io314159265359

Thus, the above will translate to the following canonical URL:

/tenants/cloudonix/domains/cloudonix.io/subscribers/314159265359

The magic self​

The Cloudonix Voice API uses the self identifier, as a means to simplify access to an API key owned resources.

Example​

Using the above mentioned resources, and assuming the developer uses a Domain API Key, the above mentioned canonical URL can be represented as:

/domains/self/subscribers/314159265359

Data Models Hierarchy​

The below diagram presents a high-level view of the Cloudonix data models and their hierarchical order.