Get Capacity Usage of a Tenant

Query the capacity usage of a tenant.

Request URL

GET {base_url}/uc-subscription/api/v1/subscription/tenant/{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	String	The tenant ID. 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_Capacity>	The tenant capacity.

Tenant_Capacity


Parameter	Type	Description
tenantId	String	The tenant ID.
regionCode	String	The code of the region to which the tenant belongs.
params	Array<Capacity_Paramater>	The list of tenant capacity parameters.

Capacity_Parameter


Parameter	Type	Description
paramKey	String	The parameter key. `users`: The number of tenant users. `tenants`: The number of tenants. `concurrentCalls`: The number of concurrent calls. `retentionTime`: The retention period for recordings. `whiteLabel`: The number of white label packs. `awsTranscription`: The number of users who can use the transcription feature. `receptionist`: The number of AI receptionist minutes. `receptionistPack`: The number of AI receptionist monthly capacity packs. `geo`: The geo redundancy capacity packs. `maxQueues`: The number of queues. `maxRingGroups`: The number of ring groups. `maxIVRs`: The number of IVRs. `maxVoicemailMessages`: The number of messages that each voicemail box stores. `maxMobileClients`: The number of Mobile Clients that be enabled for tenant users. `maxWebClients`: The number of Web Clients that be enabled for tenant users. `maxDesktopClients`: The number of Desktop Clients that be enabled for tenant users. `maxCallDuration`: The maximum duration allowed for each call. `maxMessageTime`: The maximum duration allowed for recording a voicemail. `minMessageTime`: The minimum duration allowed for recording a voicemail.
allocated	Integer	The allocated capacity. Note: A value of `-1` indicates that the capacity is unlimited.
used	Integer	The used capacity. Note: A value of `-1` indicates that the capacity is unlimited.
available	Integer	The available capacity. Note: A value of `-1` indicates that the capacity is unlimited.
unit	String	The unit of the parameter. `count` `minute`
packageValue	Integer	The value of the package.
packageUnit	String	The unit of the package. `min` `day` `month` `year`

Example

Request example

GET /uc-subscription/api/v1/subscription/tenant/2102643004438605826 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2MzM1MywiaWF0IjoxNzkyNTQxNzUzLCJqdGkiOiIyZjRmYzAwMy0zNjNlLTQxYTMtOGNjMy02YTc4ODkyM2RkMDUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.sUhcJCOi1PPz45Z88LE4MfHFifCWwnFMmpaWrIfaCLJa6f-hHf4-n4YYS1hThBtQ63D25-p-ZF-K584n3y9LKztUqaEHvI1GMmhTEJEx13EId56H0MUrxKdQEQM1MwKmTD_CAW2jh3IN3bs3LFJRIF8AUB6qoyNZGU-4nnFVS3OZlK2CcAyUiT-JiKpJpoOzluNdUI4lIcgYRUsycXtmSrf0pZuZbN-hRRpdx64S-HV4ZSKRNA34Utpgy7ZmeXyIxaVNOWKwTZyXd8SM6GXn2Br1KO7U_jOXaikQQfvZPvv_2vtKVTq-i3IflwbwhiqG2xJT9MhXDR4VWz0if3B8pg

Response example

HTTP/1.1 200 OK
{
  "result": {
    "tenantId": "2102643004438605826",
    "regionCode": "cn-0",
    "params": [
      {
        "paramKey": "users",
        "allocated": 2,
        "used": 1,
        "available": 1,
        "unit": "count"
      },
      {
        "paramKey": "maxIVRs",
        "allocated": 32,
        "used": 1,
        "available": 31,
        "unit": "count"
      },
      {
        "paramKey": "maxQueues",
        "allocated": 32,
        "used": 1,
        "available": 31,
        "unit": "count"
      },
      {
        "paramKey": "receptionist",
        "allocated": 0,
        "used": 0,
        "available": 0,
        "unit": "minute"
      },
      {
        "paramKey": "maxRingGroups",
        "allocated": 32,
        "used": 0,
        "available": 32,
        "unit": "count"
      },
      {
        "paramKey": "maxWebClients",
        "allocated": -1,
        "used": 1,
        "available": -1,
        "unit": "count"
      },
      {
        "paramKey": "maxMessageTime",
        "allocated": 600,
        "used": 0,
        "available": 600,
        "unit": "count"
      },
      {
        "paramKey": "minMessageTime",
        "allocated": 2,
        "used": 0,
        "available": 2,
        "unit": "count"
      },
      {
        "paramKey": "concurrentCalls",
        "allocated": -1,
        "used": 0,
        "available": -1,
        "unit": "count"
      },
      {
        "paramKey": "maxCallDuration",
        "allocated": 10800,
        "used": 0,
        "available": 10800,
        "unit": "count"
      },
      {
        "paramKey": "awsTranscription",
        "allocated": 0,
        "used": 0,
        "available": 0,
        "unit": "count"
      },
      {
        "paramKey": "maxMobileClients",
        "allocated": -1,
        "used": 1,
        "available": -1,
        "unit": "count"
      },
      {
        "paramKey": "maxDesktopClients",
        "allocated": -1,
        "used": 1,
        "available": -1,
        "unit": "count"
      },
      {
        "paramKey": "maxVoicemailMessages",
        "allocated": 100,
        "used": 0,
        "available": 100,
        "unit": "count"
      }
    ]
  },
  "requestId": "d6887e8baf0821c0a81e307d659444da",
  "code": "200",
  "message": "SUCCESS"
}