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 Types #
| Type | Description |
|---|---|
| KazooPbxConnectionProfile | Connection for the ~.pbx.kazoo.name.~ telephone system. |
| ThreeCxConnectionProfile | Connection for the 3CX telephone system |
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.
~.pbx.kazoo.name.~ PBX Connection Profile #
| Key | Description | Data Type |
|---|---|---|
| _type | This must be set to "KazooPbxConnectionProfile" | string |
| id | The unique identifier for this profile | GUID |
| name | A short descriptive name | string |
| tenantId | The ~.Dimensions.~ tenant Id this profile is for | GUID |
| countryCode | The country code (ISO 3166) used for telephone number identification | string |
| hostRest | The Uri of the ~.pbx.kazoo.name.~ Crossbar REST API | string |
| hostWebsocket | The Uri of the ~.pbx.kazoo.name.~ Blackhole websocket API | string |
| accountId | The account id of the ~.pbx.kazoo.name.~ Account tenant | GUID |
| apiKey | An API key that has permissions for this ~.pbx.kazoo.name.~ Account | string |
| monitorSubAccounts1 | For customers with multiple separate branch offices under a single tier. | bool |
warning
Patching a PBX profile against a customer will cause the PBX collector to be restarted. To minimise loss of data, is advisable to do this out of working hours.
info
Sub-account Monitoring is not for use on Reseller top-level accounts.
3CX PBX Connection Profile #
| Key | Description | Data Type |
|---|---|---|
| _type | This must be set to "ThreeCxConnectionProfile" | string |
| id | The unique identifier for this profile | GUID |
| name | A short descriptive name | string |
| tenantId | The ~.Dimensions.~ tenant Id this profile is for | GUID |
| licenseKey | The licence key string from the 3CX instance that will be connecting to ~.Dimensions.~. This is used to identify the incoming data. | string |
| username | The username of the account created on the 3CX instance for ~.Dimensions.~ to use | string |
| password | The password of the account created on the 3CX instance for ~.Dimensions.~ to use | string |
| enableRecordingArchive | Enables or disables the automated recording archive feature of the 3CX recordings. | bool |
| recordingArchiveFrequency | Frequency of how often 3CX recordings will be archived (HH:mm:ss:) | string |
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. |
| Get PBX Instance | Used to check if the target PBX instance is already mapped to a ~.Dimensions.~ customer somewhere. |
-
When enabled, users/calls on the accountId provided are not monitored, but those on all sub-accounts (1 tier down) are. ↩︎