Tenants

Was this helpful?

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.

get

/tenants

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/tenants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "domain": "text",
      "max_extensions": 1000,
      "max_concurrent_calls": 20,
      "enabled": true,
      "website": "text",
      "currency": "USD",
      "region": "text",
      "avatar_file_name": "text",
      "avatar_file_size": 0,
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "timezone": "text",
      "created_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Create a tenant

Create an new tenant.

post

/tenants

Authorizations

Body

namestring · min: 1 · max: 1024required

The name of the tenant.

domainstring · min: 1 · max: 280required

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 · max: 255

The official website of tenant.

currencystringrequired

The Currency code (ISO 4217).

Example: USD

regionstringrequired

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

enabledboolean · default: true

Enable this tenant or not.

enable_video_recordingboolean · default: false

Allow extension video recording.

enable_audio_recordingboolean · default: false

Allow extension audio recording.

enable_dual_track_recordingboolean · default: false

Allow dual track recording for calls.

enable_billingboolean · default: false

Enable call billing or not.

enable_feature_billingboolean · default: false

Enable call billing feature or not.

enable_feature_call_statisticsboolean · default: true

Enable call statistics feature or not.

enable_feature_contact_centerboolean · default: true

Enable contact center feature or not.

enable_feature_message_channelsboolean · default: true

Enable message channels feature or not.

enable_feature_microsoft_teamsboolean · default: true

Enable Microsoft Teams feature or not.

enable_feature_trunksboolean · default: true

Enable trunks feature or not.

enable_feature_whats_appboolean · default: true

Enable WhatsApp feature or not.

custom_optionsstring

Some custom configuration options serialized as json string

max_extensionsinteger · int32 · default: 1000

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

max_concurrent_callsinteger · int32 · default: 20

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

max_ring_groupsinteger · int32 · default: 20

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

max_virtual_receptionistsinteger · int32 · default: 20

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

max_call_queuesinteger · int32 · default: 20

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

max_conference_roomsinteger · int32 · default: 20

The maximum number of conference rooms that the tenant is allowed to be online at the same time.

disk_quotastring · default:

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 · default:

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 · default: 1GB

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 · min: 1 · default: 180

The retention period in days of recordings.

call_report_retentioninteger · min: 1 · default: 30

The retention period in days of call report files.

log_retentioninteger · min: 1 · default: 180

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

temp_file_retentioninteger · min: 1 · default: 30

The retention period in days of temporary files.

contact_match_lengthinteger · int32

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_update_intervalinteger · uint32 · min: 1 · max: 43200 · default: 720

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

contact_match_typestring · enum · default: MATCH_EXACTLY

The match method of contact:
Can be either:

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

Options: DISABLE, MATCH_EXACTLY, MATCH_LENGTH

contact_append_typestring · enum · default: DISABLE

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.

Options: DISABLE, APPEND, PREPEND

timezoneall ofrequired

Timezone for tenant.

The IANA Time Zone names, such as "Asia/Shanghai".

e164object

cdr_eventobject

extension_eventobject

office_hoursobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/tenants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "domain": "text",
    "website": "text",
    "currency": "USD",
    "region": "text",
    "enabled": true,
    "enable_video_recording": false,
    "enable_audio_recording": false,
    "enable_dual_track_recording": false,
    "enable_billing": false,
    "enable_feature_billing": false,
    "enable_feature_call_statistics": true,
    "enable_feature_contact_center": true,
    "enable_feature_message_channels": true,
    "enable_feature_microsoft_teams": true,
    "enable_feature_trunks": true,
    "enable_feature_whats_app": 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": "",
    "im_disk_quota": "",
    "extension_im_disk_quota": "1GB",
    "recording_retention": 180,
    "call_report_retention": 30,
    "log_retention": 180,
    "temp_file_retention": 30,
    "contact_match_length": 1,
    "contact_update_interval": 720,
    "contact_match_type": "MATCH_EXACTLY",
    "contact_append_type": "DISABLE",
    "timezone": "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,
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text",
      "auth": "DISABLE"
    },
    "extension_event": {
      "enabled": false,
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text",
      "auth": "DISABLE"
    },
    "office_hours": {
      "monday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "tuesday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "wednesday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "thursday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "friday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "saturday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "sunday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      }
    }
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a tenant

Get detailed properties for a tenant.

get

/tenants/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of tenant.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/tenants/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "domain": "text",
  "website": "text",
  "currency": "USD",
  "region": "text",
  "enabled": true,
  "enable_video_recording": false,
  "enable_audio_recording": false,
  "enable_dual_track_recording": false,
  "enable_billing": false,
  "enable_feature_billing": false,
  "enable_feature_call_statistics": true,
  "enable_feature_contact_center": true,
  "enable_feature_message_channels": true,
  "enable_feature_microsoft_teams": true,
  "enable_feature_trunks": true,
  "enable_feature_whats_app": 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": "",
  "used_disk_quota": "text",
  "im_disk_quota": "",
  "extension_im_disk_quota": "1GB",
  "recording_retention": 180,
  "call_report_retention": 30,
  "log_retention": 180,
  "temp_file_retention": 30,
  "contact_match_length": 1,
  "contact_update_interval": 720,
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "contact_match_type": "MATCH_EXACTLY",
  "contact_append_type": "DISABLE",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "timezone": "text",
  "created_at": "2017-07-21T17:32:28Z",
  "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,
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text",
    "auth": "DISABLE"
  },
  "extension_event": {
    "enabled": false,
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text",
    "auth": "DISABLE"
  },
  "outbound_caller_ids": [
    {
      "description": "text",
      "caller_id": "text",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ],
  "office_hours": {
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  }
}

Update a tenant

Update tenant properties by it's unique ID.

post

/tenants/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of tenant.

The unique ID of the resource.

Body

domainstring · min: 1 · max: 280

websitestring · max: 255

The official website of 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 · default: true

Enable this tenant or not.

enable_video_recordingboolean · default: false

Allow extension video recording.

enable_audio_recordingboolean · default: false

Allow extension audio recording.

enable_dual_track_recordingboolean · default: false

Allow dual track recording for calls.

enable_billingboolean · default: false

Enable call billing or not.

enable_feature_billingboolean · default: false

Enable call billing feature or not.

enable_feature_call_statisticsboolean · default: true

Enable call statistics feature or not.

enable_feature_contact_centerboolean · default: true

Enable contact center feature or not.

enable_feature_message_channelsboolean · default: true

Enable message channels feature or not.

enable_feature_microsoft_teamsboolean · default: true

Enable Microsoft Teams feature or not.

enable_feature_trunksboolean · default: true

Enable trunks feature or not.

enable_feature_whats_appboolean · default: true

Enable WhatsApp feature or not.

custom_optionsstring

Some custom configuration options serialized as json string

max_extensionsinteger · int32 · default: 1000

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

max_concurrent_callsinteger · int32 · default: 20

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

max_ring_groupsinteger · int32 · default: 20

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

max_virtual_receptionistsinteger · int32 · default: 20

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

max_call_queuesinteger · int32 · default: 20

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

max_conference_roomsinteger · int32 · default: 20

The maximum number of conference rooms that the tenant is allowed to be online at the same time.

disk_quotastring · default:

im_disk_quotastring · default:

extension_im_disk_quotastring · default: 1GB

recording_retentioninteger · int32 · min: 1 · default: 180

The retention period in days of recordings.

call_report_retentioninteger · min: 1 · default: 30

The retention period in days of call report files.

log_retentioninteger · min: 1 · default: 180

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

temp_file_retentioninteger · min: 1 · default: 30

The retention period in days of temporary files.

contact_match_lengthinteger · int32

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_update_intervalinteger · uint32 · min: 1 · max: 43200 · default: 720

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

contact_match_typestring · enum · default: MATCH_EXACTLY

The match method of contact:
Can be either:

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

Options: DISABLE, MATCH_EXACTLY, MATCH_LENGTH

contact_append_typestring · enum · default: DISABLE

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.

Options: DISABLE, APPEND, PREPEND

timezoneall of

Timezone for tenant.

The IANA Time Zone names, such as "Asia/Shanghai".

e164object

cdr_eventobject

extension_eventobject

office_hoursobject

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/tenants/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "domain": "text",
    "website": "text",
    "currency": "USD",
    "region": "text",
    "enabled": true,
    "enable_video_recording": false,
    "enable_audio_recording": false,
    "enable_dual_track_recording": false,
    "enable_billing": false,
    "enable_feature_billing": false,
    "enable_feature_call_statistics": true,
    "enable_feature_contact_center": true,
    "enable_feature_message_channels": true,
    "enable_feature_microsoft_teams": true,
    "enable_feature_trunks": true,
    "enable_feature_whats_app": 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": "",
    "im_disk_quota": "",
    "extension_im_disk_quota": "1GB",
    "recording_retention": 180,
    "call_report_retention": 30,
    "log_retention": 180,
    "temp_file_retention": 30,
    "contact_match_length": 1,
    "contact_update_interval": 720,
    "contact_match_type": "MATCH_EXACTLY",
    "contact_append_type": "DISABLE",
    "timezone": "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,
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text",
      "auth": "DISABLE"
    },
    "extension_event": {
      "enabled": false,
      "username": "text",
      "password": "text",
      "token": "text",
      "url": "text",
      "auth": "DISABLE"
    },
    "office_hours": {
      "monday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "tuesday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "wednesday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "thursday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "friday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "saturday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      },
      "sunday": {
        "enabled": true,
        "ranges": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ]
      }
    }
  }'

200

4XX

No body