Overview #

The API can be used to provision customers and manage users and PBX connections. The information below outlines the format used for API requests and responses.

API Interaction #

The API requires the use of Json format definitions for the content of any requests. Any responses will be returned in Json format using the following template:

{
	"data": {
		<returned data>
	},
	"error": <errorCode>,
	"message": <message>,
	"status": <status>,
	"timestamp": <timestamp UTC>
}

warning
Some fields may not always be returned

If the data returned is a collection, it will return an array with the page size.

{
	"page_size": "<number of items>",
	"data": [{
			"id": "90ce2cce-5b90-424b-b502-55924f140a48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	],
	"status": "success",
	"timestamp": "<timestamp in UTC>"
}

API Resources #

The following table provides an outline of the resources the API provides access to:

Resource	Description
Customers	Manage tenant records for a customer. Create, update or terminate customer accounts.
Customer Users	Manage the users for a tenant. Add users or update roles to allow access to the portal or change license levels.
Customer PBX Profiles	Manage PBX connections for a tenant, provide information on how to connect to the customer’s communications platform(s).
Customer Tenant Profiles	Query the tenant profiles available to this customer.
Billing Data	Query monthly billing data including invoices PDFs, Service Data Records and where applicable, CDRS.

Each resource provides the following interfaces for interaction:

Interface	Description
Get All	Returns a collection of all items matching the resource type.
Get…	Returns a specific instance of the resource type.
Create…	Creates a new instance of a resource type.
Patch…	Updates an existing instance of resource type.
Delete…	Removes an existing instance of a resource type.