Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Tenant

Update a tenant

Set tenant object that already exists.

post/tenant

Request body

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.

timezonestring

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

currencystring

The Currency code (ISO 4217).

regionstring

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

enable_video_recordingboolean

Allow extension video recording.

enable_audio_recordingboolean

Allow extension audio recording.

enable_dual_track_recordingboolean

Allow dual track recording for calls.

custom_optionsstring

Some custom configuration options serialized as json string

recording_retentioninteger

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.

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.

contact_match_type'DISABLE' | 'MATCH_EXACTLY' | 'MATCH_LENGTH'

The match method of contact:
Can be either:

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

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_type'DISABLE' | 'APPEND' | 'PREPEND'

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.
contact_update_intervalinteger

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

avatar_file_idstring

The unique ID of the resource.

stir_shaken_certstring

Content of this certificate file for STIR/SHAKEN support.

stir_shaken_keystring

Content of this private certificate file for STIR/SHAKEN support.

Example request

{
  "currency": "USD",
  "office_hours": {
    "monday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ],
  "e164": {
    "country": "Angola(244)"
  },
  "avatar_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Response

OK