Get Tenant Details

Retrieve the details of a specified tenant.

Request URL

GET {base_url}/uc-tenant/api/v1/tenants/{tenantId}

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.

Path parameters


Parameter	Required	Type	Description
tenantId	Yes	Integer	The ID of the tenant. Note: You can obtain the ID using the Query Tenants interface.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Tenant_Details>	The details of the tenant.

Tenant_Details


Parameter	Type	Description
tenantId	String	The ID of the tenant.
basic	Object<Tenant_Basic>	The basic information of the tenant.
defaultConfig	Object<Tenant_Preference>	The preferences of the tenant.
limitations	Object<Tenant_Limitation>	The resource limits of the tenant.
assignments	Array<Tenant_DID>	The DID assignment information.
codecConfig	Object<Tenant_Codec>	The codec configuration.
defaultOutboundCallerIds	Array<Default_Outbound_Caller_ID>	The list of default outbound caller IDs.
customHeaderValues	Array<Custom_Header>	The list of custom SIP header values.

Tenant_Basic


Parameter	Type	Description
owner	String	The user ID of the tenant owner.
status	String	The status of the tenant. `ACTIVE`: The tenant is active. `SUSPENDED`: The tenant is suspended.
name	String	The name of the tenant.
description	String	The description of the tenant.
ownerUcId	String	The UC ID of the company to which the tenant owner belongs.
ownerSubType	String	The subtype of the owner. `SUPER`: Super administrator. `ADMIN`: Administrator. `RESELLER`: Reseller.
brandId	String	The brand ID.
oemId	Integer	The ID of the OEM to which the brand belongs.

Tenant_Preference


Parameter	Type	Description
country	String	The country or region where the tenant is located.
nameDisplayFormat	String	The format used to display names. `fls`: First Name Last Name with Space Inbetween `lfs`: Last Name First Name with Space Inbetween `lf`: Last Name First Name without Space Inbetween
toneRegion	String	The short code of the tone region used to apply the default dial tone, busy tone, and ring tone.
timeZone	String	The time zone.
daylightSavingTime	String	Whether daylight saving time is enabled. `Disabled`: Daylight saving time is disabled. `Automatic`: Daylight saving time is applied automatically.
dateDisplayFormat	String	The date display format. `yyyy/mm/dd`: Year/Month/Day `mm/dd/yyyy`: Month/Day/Year `dd/mm/yyyy`: Day/Month/Year
timeDisplayFormat	String	The time display format. `hh:mm:ss A`: 12-hour format. `HH:mm:ss`: 24-hour format.
systemPromptLanguage	String	The language used for system prompts.
emailNotificationLanguage	String	The language used for email notifications.
displayCountryCode	String	The format used to display phone numbers. `INTERNATIONAL`: Display numbers in international format, starting with a plus sign (`+`) followed by the country code, area code, and local number. `DOMESTIC`: Display numbers in domestic format, using the area code and local number without the country code.
callerIdResolution	Array<String>	The sources used to resolve the Caller ID name. `system_contacts`: Display the matched contact name when an incoming call matches an internal user or external contact. `caller_id_name`: Display the name carried in the From header of the SIP message.
displayCallFeature	Boolean	Whether the call feature name is included in the Caller ID Name for incoming calls routed through a ring group, queue, or IVR.
displayDidName	Boolean	Whether the associated DID name is displayed when receiving incoming calls through a DID number.

Tenant_Limitation


Parameter	Type	Description
maxUsers	Object<Resource_Quota>	The maximum number of users.
maxConcurrentCalls	Object<Resource_Quota>	The maximum number of concurrent calls.
maxCallDurations	Object<Resource_Quota>	The maximum duration of a single call.
recordingUsers	Array<Recording_User>	The list of recording user assignments.
maxQueues	Integer	The maximum number of queues.
maxRingGroups	Integer	The maximum number of ring groups.
maxIvrs	Integer	The maximum number of IVRs.
maxMessageTime	Integer	The maximum message duration.
minMessageTime	Integer	The minimum message duration.
maxVoicemailMessages	Integer	The maximum number of voicemail messages each voicemail box can store.
maxMobileClients	Object<Resource_Quota>	The maximum number of NovoOne Mobile Clients.
maxDesktopClients	Object<Resource_Quota>	The maximum number of NovoOne Desktop Clients.
maxWebClients	Object<Resource_Quota>	The maximum number of NovoOne Web Clients.
maxAwsTranscriptionUsers	Object<Resource_Quota>	The maximum number of transcription users.
maxReceptionistMinutes	Object<Resource_Quota>	The maximum number of AI Receptionist minutes.
maxReceptionistPackMinutes	Object<Resource_Quota>	The maximum number of AI Receptionist monthly minute pack.

Resource_Quota


Parameter	Type	Description
limited	Boolean	Whether the quota is limited. `true`: The quota is limited. `false`: The quota is unlimited.
total	Integer	The total quota.

Recording_User


Parameter	Type	Description
allocatedValue	Integer	The number of recording users allocated to the tenant for the specified recording retention period.
unitValue	Integer	The value of the recording retention period.
unit	String	The unit of the recording retention period. `day`: Days. `month`: Months. `year`: Years.

Tenant_DID


Parameter	Type	Description
trunkId	Integer	The trunk ID.
dids	Array<Integer>	The list of DID IDs.
inboundLimit	Integer	The inbound call limit.
outboundLimit	Integer	The outbound call limit.
totalLimit	Integer	The total call limit.

Tenant_Codec


Parameter	Type	Description
audioCodecs	Array<String>	The list of audio codecs.
audioCodecsWifi	Array<String>	The list of audio codecs used over Wi-Fi networks.
audioCodecsCellular	Array<String>	The list of audio codecs used over cellular networks.

Default_Outbound_Caller_ID


Parameter	Type	Description
trunkId	Integer	The trunk ID.
didId	Integer	The DID ID.

Custom_Header


Parameter	Type	Description
trunkId	Integer	The trunk ID.
values	Array<Custom_Header_Value>	The list of custom SIP header values.

Custom_Header_Value


Parameter	Type	Description
id	String	The header ID.
name	String	The header name.
value	String	The header value.

Example

Request example

GET /uc-tenant/api/v1/tenants/2110275024254992385 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTk4NTEyOSwiaWF0IjoxNzkxOTYzNTI5LCJqdGkiOiI4OWEzZGNjZi0xODUwLTQ4ODQtOGFmOS1mNGFmY2I2MzljNWIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.M6uGO4Ocer4JKJLJ5ZIafLRIs5yqPMa0Y_RIiwQTb2bWsr5DViU0jgbjca91VukjmGNplQV0U0QoX17I6Y6EhytUkHWTjW1FkEWJiu7CPCob_qDcta9RyT-Hio36HViBsoU1fewmFyufrl5Li1KLxnuREIWklyImMH4-JJwsni7-19l537NIog150PtePm5RalOLCcvE0a4DbD9MV7aPaHaBfWhxXgZJvAB_13tG_ELkVny7Mpwcui-b1kGeis9gWL878M0ZpIJ20OHk578BeL60PDh3IiInYeQMrmCT2p04KQqDyFI6KuIz85I85a6bJKa9ntzJJv3q-s9lBZuELw
Content-Type: application/json

Response example

HTTP/1.1 200 OK
{
  "result": {
    "tenantId": "2110275024254992385",
    "basic": {
      "owner": "3076913644915998720",
      "status": "ACTIVE",
      "name": "ait-doc-test-02",
      "description": "",
      "ownerUcId": "3076913644890832896",
      "ownerSubType": "ADMIN",
      "brandId": "2089256397261770753",
      "oemId": 0
    },
    "defaultConfig": {
      "country": "China",
      "nameDisplayFormat": "fls",
      "toneRegion": "cn",
      "timeZone": "UTC+8 Asia/Shanghai",
      "daylightSavingTime": "Disabled",
      "dateDisplayFormat": "yyyy/mm/dd",
      "timeDisplayFormat": "HH:mm:ss",
      "systemPromptLanguage": "",
      "emailNotificationLanguage": "en",
      "displayCountryCode": false,
      "callerIdResolution": [
        "system_contacts",
        "caller_id_name"
      ],
      "displayCallFeature": true,
      "displayDidName": true
    },
    "limitations": {
      "maxUsers": {
        "limited": true,
        "total": 10
      },
      "maxConcurrentCalls": {
        "limited": true,
        "total": 10
      },
      "maxCallDurations": {
        "limited": true,
        "total": 3600
      },
      "recordingUsers": [],
      "maxQueues": 5,
      "maxRingGroups": 0,
      "maxIvrs": 0,
      "maxMessageTime": 0,
      "minMessageTime": 0,
      "maxVoicemailMessages": 0,
      "maxMobileClients": {
        "limited": true,
        "total": 5
      },
      "maxDesktopClients": {
        "limited": true,
        "total": 5
      },
      "maxWebClients": {
        "limited": true,
        "total": 5
      },
      "maxAwsTranscriptionUsers": {
        "limited": true,
        "total": 0
      },
      "maxReceptionistMinutes": {
        "limited": true,
        "total": 0
      }
    },
    "codecConfig": {
      "audioCodecs": [
        "PCMU",
        "PCMA",
        "G722",
        "G729",
        "OPUS"
      ],
      "videoCodecs": [
        "H264",
        "VP8"
      ],
      "audioCodecsWifi": [
        "OPUS",
        "PCMU",
        "PCMA",
        "G722",
        "G729"
      ],
      "audioCodecsCellular": [
        "OPUS",
        "PCMU",
        "PCMA",
        "G722",
        "G729"
      ]
    }
  },
  "requestId": "a33d1d0c7d5b36a91717646578bf5a85",
  "code": "200",
  "message": "SUCCESS"
}