PBX Profiles #
The PbxConnectionProfiles resource allows for the management of Customer PBX connections. The base URI for all request is:
/{VERSION}/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}
This is what tells the system how to make a connection to the API on the Customers telephone system. As each type of telephone system is different then they will require a different set of details.
PBX Profiles Schema #
This contains the details required to be able to connect to the PBX system for this Customer. As each type of PBX may require a different set of information there are additional details for each type.
| Key | Description |
|---|---|
| _type | Set to the specific PBX type |
| id | A short descriptive name |
| name | The unique identifier for this profile |
| tenantId | The tenant Id this profile is for |
| countryCode | The country code (ISO 3166) used for telephone number identification |
~.pbx.kazoo.name.~ PBX Connection Profile #
This is in addition to the pbxConnectionProfile
| Key | Description |
|---|---|
| _type | This must be set to “KazooPbxConnectionProfile” |
| hostRest | The Uri of the ~.pbx.kazoo.name.~ Crossbar REST API |
| hostWebsocket | The Uri of the ~.pbx.kazoo.name.~ Blackhole websocket API |
| accountId | The account id of the ~.pbx.kazoo.name.~ Account tenant |
| apiKey | An API key that has permissions for this ~.pbx.kazoo.name.~ Account |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all PBXs. |
| Get PBX | Returns a specific PBX instance. |
| Create PBX | Creates a new PBX instance. |
| Patch PBX | Updates an existing PBX instance. |
| Delete PBX | Removes an existing PBX instance. |