Tenants

List tenants

Returns a list of tenant summary information. Note that it uses a different, smaller representation of a tenant than retrieving a single tenant.

GEThttp://127.0.0.1:8888/api/tenants

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/tenants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "domain": "text",
      "max_extensions": 1000,
      "max_concurrent_calls": 20,
      "enabled": true,
      "website": "text",
      "timezone": {},
      "currency": "USD",
      "region": "text",
      "avatar_file_name": "text",
      "avatar_file_size": 0,
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "created_at": {}
    }
  ]
}

Create a tenant

Create an new tenant.

POSThttp://127.0.0.1:8888/api/tenants

Body

application/json

name*string

The name of the tenant.

domain*string

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

websitestring

The official website of tenant.

timezone*all of

Timezone for tenant.

currency*string

The Currency code (ISO 4217).

Example: "USD"

region*string

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

enabledboolean

Enable this tenant or not.

enable_video_recordingboolean

Allow extension video recording.

enable_audio_recordingboolean

Allow extension audio recording.

enable_dual_track_recordingboolean

Allow dual track recording for calls.

enable_billingboolean

Enable call billing or not.

enable_feature_billingboolean

Enable call billing feature or not.

enable_feature_call_statisticsboolean

Enable call statistics feature or not.

enable_feature_contact_centerboolean

Enable contact center feature or not.

enable_concurrent_loginboolean

Allow concurrent login enable.

custom_optionsstring

Some custom configuration options serialized as json string

max_extensionsinteger (int32)

The maximum number of users that the tenant is allowed to create.

max_concurrent_callsinteger (int32)

The maximum number of concurrent calls that the tenant is allowed to have.

max_ring_groupsinteger (int32)

The maximum number of ring groups that the tenant is allowed to create.

max_virtual_receptionistsinteger (int32)

The maximum number of virtual receptionists that the tenant is allowed to create.

max_call_queuesinteger (int32)

The maximum number of call queues that the tenant is allowed to create.

max_conference_roomsinteger (int32)

The maximum number of conference rooms that the tenant is allowed to create.

disk_quotastring

The maximum size of disk space that the tenant is allowed to have.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

im_disk_quotastring

The maximum size of disk space that the tenant is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

extension_im_disk_quotastring

The maximum size of disk space that the extension user is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

recording_retentioninteger (int32)

The retention period in days of recordings.

call_report_retentioninteger

The retention period in days of call report files.

log_retentioninteger

The retention period in days of audit logs and event logs.

temp_file_retentioninteger

The retention period in days of temporary files.

office_hoursobject

e164object

cdr_eventobject

extension_eventobject

contact_match_typeenum

The match method of contact:
Can be either:

• DISABLE: Disable match.
• MATCH_EXACTLY: Match exactly.
• MATCH_LENGTH: Match at least specified number of characters.

DISABLEMATCH_EXACTLYMATCH_LENGTH

contact_match_lengthinteger (int32)

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_typeenum

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

• DISABLE: Do not add.
• APPEND: Append names.
• PREPEND: Prepend names.

DISABLEAPPENDPREPEND

contact_update_intervalinteger (uint32)

The interval for synchronizing contacts from the server, in minutes.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of tenant.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/tenants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "domain": "text",
      "timezone": {},
      "currency": "USD",
      "region": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a tenant

Get detailed properties for a tenant.

GEThttp://127.0.0.1:8888/api/tenants/{id}

Path parameters

id*all of

The unique ID of tenant.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of tenant.

namestring

The name of the tenant.

domainstring

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

websitestring

The official website of tenant.

timezoneall of

Timezone for tenant.

currencystring

The Currency code (ISO 4217).

Example: "USD"

regionstring

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

enabledboolean

Enable this tenant or not.

enable_video_recordingboolean

Allow extension video recording.

enable_audio_recordingboolean

Allow extension audio recording.

enable_dual_track_recordingboolean

Allow dual track recording for calls.

enable_concurrent_loginboolean

Allow concurrent login enable.

enable_billingboolean

Enable call billing or not.

enable_feature_billingboolean

Enable call billing feature or not.

enable_feature_call_statisticsboolean

Enable call statistics feature or not.

enable_feature_contact_centerboolean

Enable contact center feature or not.

custom_optionsstring

Some custom configuration options serialized as json string

max_extensionsinteger (int32)

The maximum number of users that the tenant is allowed to create.

max_concurrent_callsinteger (int32)

The maximum number of concurrent calls that the tenant is allowed to have.

max_ring_groupsinteger (int32)

The maximum number of ring groups that the tenant is allowed to create.

max_virtual_receptionistsinteger (int32)

The maximum number of virtual receptionists that the tenant is allowed to create.

max_call_queuesinteger (int32)

The maximum number of call queues that the tenant is allowed to create.

max_conference_roomsinteger (int32)

The maximum number of conference rooms that the tenant is allowed to create.

disk_quotastring

The maximum size of disk space that the tenant is allowed to have.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

used_disk_quotastring

The used disk quota, an number followed by unit (KB, MB, GB, PB).

im_disk_quotastring

The maximum size of disk space that the tenant is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

extension_im_disk_quotastring

The maximum size of disk space that the extension user is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

recording_retentioninteger (int32)

The retention period in days of recordings.

call_report_retentioninteger

The retention period in days of call report files.

log_retentioninteger

The retention period in days of audit logs and event logs.

temp_file_retentioninteger

The retention period in days of temporary files.

office_hoursobject

outbound_caller_idsarray of object

A collection of outbound caller IDs.

e164object

cdr_eventobject

extension_eventobject

contact_match_typeenum

The match method of contact:
Can be either:

• DISABLE: Disable match.
• MATCH_EXACTLY: Match exactly.
• MATCH_LENGTH: Match at least specified number of characters.

DISABLEMATCH_EXACTLYMATCH_LENGTH

contact_match_lengthinteger (int32)

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_typeenum

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

• DISABLE: Do not add.
• APPEND: Append names.
• PREPEND: Prepend names.

DISABLEAPPENDPREPEND

contact_update_intervalinteger (uint32)

The interval for synchronizing contacts from the server, in minutes.

created_atall of

The creation time of tenant.

avatar_file_namestring

The name of the file.

avatar_file_sizeinteger (int64)

The file size in bytes.

Example: 0

avatar_file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/tenants/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "domain": "text",
  "website": "text",
  "timezone": {},
  "currency": "USD",
  "region": "text",
  "enabled": true,
  "enable_video_recording": false,
  "enable_audio_recording": false,
  "enable_dual_track_recording": false,
  "enable_concurrent_login": true,
  "enable_billing": false,
  "enable_feature_billing": false,
  "enable_feature_call_statistics": true,
  "enable_feature_contact_center": true,
  "custom_options": "text",
  "max_extensions": 1000,
  "max_concurrent_calls": 20,
  "max_ring_groups": 20,
  "max_virtual_receptionists": 20,
  "max_call_queues": 20,
  "max_conference_rooms": 20,
  "disk_quota": "text",
  "used_disk_quota": "text",
  "im_disk_quota": "text",
  "extension_im_disk_quota": "1GB",
  "recording_retention": 180,
  "call_report_retention": 30,
  "log_retention": 180,
  "temp_file_retention": 30,
  "office_hours": {
    "monday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "outbound_caller_ids": [
    {
      "provider_id": {},
      "caller_id": {},
      "description": "text"
    }
  ],
  "e164": {
    "enabled": false,
    "international_code": "text",
    "country": "Angola(244)",
    "area_code": "text",
    "national_code": "text",
    "prefix": "text",
    "remove_special_chars": false,
    "remove_duplicate_countries": true,
    "remove_duplicate_area_codes": true
  },
  "cdr_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "extension_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "contact_match_type": "DISABLE",
  "contact_match_length": 0,
  "contact_append_type": "DISABLE",
  "contact_update_interval": 10080,
  "created_at": {},
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Update a tenant

Update tenant properties by it's unique ID.

POSThttp://127.0.0.1:8888/api/tenants/{id}

Path parameters

id*all of

The unique ID of tenant.

Body

application/json

domainstring

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

websitestring

The official website of tenant.

timezoneall of

Timezone for tenant.

currencystring

The Currency code (ISO 4217).

Example: "USD"

regionstring

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

enabledboolean

Enable this tenant or not.

enable_video_recordingboolean

Allow extension video recording.

enable_audio_recordingboolean

Allow extension audio recording.

enable_dual_track_recordingboolean

Allow dual track recording for calls.

enable_concurrent_loginboolean

Allow concurrent login enable.

enable_billingboolean

Enable call billing or not.

enable_feature_billingboolean

Enable call billing feature or not.

enable_feature_call_statisticsboolean

Enable call statistics feature or not.

enable_feature_contact_centerboolean

Enable contact center feature or not.

custom_optionsstring

Some custom configuration options serialized as json string

max_extensionsinteger (int32)

The maximum number of users that the tenant is allowed to create.

max_concurrent_callsinteger (int32)

The maximum number of concurrent calls that the tenant is allowed to have.

max_ring_groupsinteger (int32)

The maximum number of ring groups that the tenant is allowed to create.

max_virtual_receptionistsinteger (int32)

The maximum number of virtual receptionists that the tenant is allowed to create.

max_call_queuesinteger (int32)

The maximum number of call queues that the tenant is allowed to create.

max_conference_roomsinteger (int32)

The maximum number of conference rooms that the tenant is allowed to create.

disk_quotastring

The maximum size of disk space that the tenant is allowed to have.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

im_disk_quotastring

The maximum size of disk space that the tenant is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

extension_im_disk_quotastring

The maximum size of disk space that the extension user is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

recording_retentioninteger (int32)

The retention period in days of recordings.

call_report_retentioninteger

The retention period in days of call report files.

log_retentioninteger

The retention period in days of audit logs and event logs.

temp_file_retentioninteger

The retention period in days of temporary files.

office_hoursobject

e164object

cdr_eventobject

extension_eventobject

contact_match_typeenum

The match method of contact:
Can be either:

• DISABLE: Disable match.
• MATCH_EXACTLY: Match exactly.
• MATCH_LENGTH: Match at least specified number of characters.

DISABLEMATCH_EXACTLYMATCH_LENGTH

contact_match_lengthinteger (int32)

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_typeenum

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

• DISABLE: Do not add.
• APPEND: Append names.
• PREPEND: Prepend names.

DISABLEAPPENDPREPEND

contact_update_intervalinteger (uint32)

The interval for synchronizing contacts from the server, in minutes.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/tenants/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();