Returns a list of tenant summary information. Note that it uses a different, smaller representation of a tenant than retrieving a single tenant.
OK
Total number of resource.
100
Update tenant properties by it's unique ID.
The unique ID of tenant.
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.
The official website of tenant.
Timezone for tenant.
The Currency code (ISO 4217).
"USD"
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Enable this tenant or not.
Allow extension video recording.
Allow extension audio recording.
Allow dual track recording for calls.
Allow concurrent login enable.
Enable call billing or not.
Enable call billing feature or not.
Enable call statistics feature or not.
Enable contact center feature or not.
Some custom configuration options serialized as json string
The maximum number of users that the tenant is allowed to create.
The maximum number of concurrent calls that the tenant is allowed to have.
The maximum number of ring groups that the tenant is allowed to create.
The maximum number of virtual receptionists that the tenant is allowed to create.
The maximum number of call queues that the tenant is allowed to create.
The maximum number of conference rooms that the tenant is allowed to create.
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.
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.
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.
The retention period in days of recordings.
The retention period in days of call report files.
The retention period in days of audit logs and event logs.
The retention period in days of temporary files.
The match method of contact:
Can be either:
DISABLE
: Disable match.MATCH_EXACTLY
: Match exactly.MATCH_LENGTH
: Match at least specified number of characters.The matched length of characters when contact_match_type is MATCH_LENGTH
.
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.The interval for synchronizing contacts from the server, in minutes.
OK
Create an new tenant.
The name of the tenant.
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.
The official website of tenant.
Timezone for tenant.
The Currency code (ISO 4217).
"USD"
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Enable this tenant or not.
Allow extension video recording.
Allow extension audio recording.
Allow dual track recording for calls.
Enable call billing or not.
Enable call billing feature or not.
Enable call statistics feature or not.
Enable contact center feature or not.
Allow concurrent login enable.
Some custom configuration options serialized as json string
The maximum number of users that the tenant is allowed to create.
The maximum number of concurrent calls that the tenant is allowed to have.
The maximum number of ring groups that the tenant is allowed to create.
The maximum number of virtual receptionists that the tenant is allowed to create.
The maximum number of call queues that the tenant is allowed to create.
The maximum number of conference rooms that the tenant is allowed to create.
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.
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.
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.
The retention period in days of recordings.
The retention period in days of call report files.
The retention period in days of audit logs and event logs.
The retention period in days of temporary files.
The match method of contact:
Can be either:
DISABLE
: Disable match.MATCH_EXACTLY
: Match exactly.MATCH_LENGTH
: Match at least specified number of characters.The matched length of characters when contact_match_type is MATCH_LENGTH
.
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.The interval for synchronizing contacts from the server, in minutes.
Created
The unique ID of tenant.
Get detailed properties for a tenant.
The unique ID of tenant.
OK
The unique ID of tenant.
The name of the tenant.
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.
The official website of tenant.
Timezone for tenant.
The Currency code (ISO 4217).
"USD"
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Enable this tenant or not.
Allow extension video recording.
Allow extension audio recording.
Allow dual track recording for calls.
Allow concurrent login enable.
Enable call billing or not.
Enable call billing feature or not.
Enable call statistics feature or not.
Enable contact center feature or not.
Some custom configuration options serialized as json string
The maximum number of users that the tenant is allowed to create.
The maximum number of concurrent calls that the tenant is allowed to have.
The maximum number of ring groups that the tenant is allowed to create.
The maximum number of virtual receptionists that the tenant is allowed to create.
The maximum number of call queues that the tenant is allowed to create.
The maximum number of conference rooms that the tenant is allowed to create.
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.
The used disk quota, an number followed by unit (KB, MB, GB, PB).
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.
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.
The retention period in days of recordings.
The retention period in days of call report files.
The retention period in days of audit logs and event logs.
The retention period in days of temporary files.
A collection of outbound caller IDs.
The match method of contact:
Can be either:
DISABLE
: Disable match.MATCH_EXACTLY
: Match exactly.MATCH_LENGTH
: Match at least specified number of characters.The matched length of characters when contact_match_type is MATCH_LENGTH
.
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.The interval for synchronizing contacts from the server, in minutes.
The creation time of tenant.
The name of the file.
The file size in bytes.
0
The relative path to file url for file downloading.
"/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"