Tenants
Returns a list of tenant summary information. Note that it uses a different, smaller representation of a tenant than retrieving a single tenant.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /api/tenants HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"domain": "text",
"max_extensions": 1000,
"max_concurrent_calls": 20,
"enabled": true,
"website": "text",
"timezone": "text",
"currency": "USD",
"region": "text",
"avatar_file_name": "text",
"avatar_file_size": 0,
"avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
"created_at": "2017-07-21T17:32:28Z"
}
]
}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 IANA Time Zone names, such as "Asia/Shanghai".
The Currency code (ISO 4217).
USDA 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.
trueAllow extension video recording.
falseAllow extension audio recording.
falseAllow dual track recording for calls.
falseEnable call billing or not.
falseEnable call billing feature or not.
falseEnable call statistics feature or not.
trueEnable contact center feature or not.
trueEnable message channels feature or not.
trueEnable Microsoft Teams feature or not.
trueEnable trunks feature or not.
trueEnable WhatsApp feature or not.
trueSome custom configuration options serialized as json string
The maximum number of users that the tenant is allowed to create.
1000The maximum number of concurrent calls that the tenant is allowed to have.
20The maximum number of ring groups that the tenant is allowed to create.
20The maximum number of virtual receptionists that the tenant is allowed to create.
20The maximum number of call queues that the tenant is allowed to create.
20The maximum number of conference rooms that the tenant is allowed to be online at the same time.
20The 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.
1GBThe retention period in days of recordings.
180The retention period in days of call report files.
30The retention period in days of audit logs and event logs.
180The retention period in days of temporary files.
30The match method of contact:
Can be either:
DISABLE: Disable match.MATCH_EXACTLY: Match exactly.MATCH_LENGTH: Match at least specified number of characters.
MATCH_EXACTLYPossible values: 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.
DISABLEPossible values: The interval for synchronizing contacts from the server, in minutes.
720POST /api/tenants HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1894
{
"name": "text",
"domain": "text",
"website": "text",
"timezone": "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,
"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"
}
]
}
},
"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": "MATCH_EXACTLY",
"contact_match_length": 1,
"contact_append_type": "DISABLE",
"contact_update_interval": 720
}{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}Get detailed properties for a tenant.
The unique ID of tenant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /api/tenants/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"domain": "text",
"website": "text",
"timezone": "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,
"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"
}
]
}
},
"outbound_caller_ids": [
{
"provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"caller_id": "text",
"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": "MATCH_EXACTLY",
"contact_match_length": 1,
"contact_append_type": "DISABLE",
"contact_update_interval": 720,
"created_at": "2017-07-21T17:32:28Z",
"avatar_file_name": "text",
"avatar_file_size": 0,
"avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}Update tenant properties by it's unique ID.
The unique ID of tenant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe 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 IANA Time Zone names, such as "Asia/Shanghai".
The Currency code (ISO 4217).
USDA 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.
trueAllow extension video recording.
falseAllow extension audio recording.
falseAllow dual track recording for calls.
falseEnable call billing or not.
falseEnable call billing feature or not.
falseEnable call statistics feature or not.
trueEnable contact center feature or not.
trueEnable message channels feature or not.
trueEnable Microsoft Teams feature or not.
trueEnable trunks feature or not.
trueEnable WhatsApp feature or not.
trueSome custom configuration options serialized as json string
The maximum number of users that the tenant is allowed to create.
1000The maximum number of concurrent calls that the tenant is allowed to have.
20The maximum number of ring groups that the tenant is allowed to create.
20The maximum number of virtual receptionists that the tenant is allowed to create.
20The maximum number of call queues that the tenant is allowed to create.
20The maximum number of conference rooms that the tenant is allowed to be online at the same time.
20The 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.
1GBThe retention period in days of recordings.
180The retention period in days of call report files.
30The retention period in days of audit logs and event logs.
180The retention period in days of temporary files.
30The match method of contact:
Can be either:
DISABLE: Disable match.MATCH_EXACTLY: Match exactly.MATCH_LENGTH: Match at least specified number of characters.
MATCH_EXACTLYPossible values: 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.
DISABLEPossible values: The interval for synchronizing contacts from the server, in minutes.
720POST /api/tenants/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1880
{
"domain": "text",
"website": "text",
"timezone": "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,
"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"
}
]
}
},
"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": "MATCH_EXACTLY",
"contact_match_length": 1,
"contact_append_type": "DISABLE",
"contact_update_interval": 720
}No content