Query Capacity Allocation for Own Tenants

Query the details of capacity allocation for you own tenants.

Request URL

GET {base_url}/uc-subscription/api/v1/subscription/usage/self-colleague

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
pageNumber Yes Integer The page number to retrieve.
pageSize Yes Integer The number of records to retrieve per page.
paramKey Yes String The key for service or parameter.

Valid value:

  • novoone: NovoOne plan.
  • call_recording_srv: Call recording service.
  • white_label_srv: White label service.
  • transcription_srv: Transcription service.
  • ai_receptionist_srv: AI receptionist service (on-demand minute pack).
  • receptionist_pack_srv: AI receptionist service (monthly rolling plan).
  • geo_redundancy_srv: Geo redundancy service.
  • 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.
paramId No String The ID of the parameter.
Note: You can query the parameter ID using the Get Subscription Information interface.
userName No String The tenant name.
creator No String The name or email address of the tenant creator.
startTime No Integer The start of the allocation time range, in Unix timestamp format (milliseconds).
endTime No Integer The end of the allocation time range, in Unix timestamp format (milliseconds).

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<Capacity_Allocation> The capacity allocation details of the tenants.
Capacity_Allocation
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
total Integer The total number of records that match the query conditions.
results Array<Allocation_Record> The list of allocation records.
Note: An empty array is returned when no record matches or the page number is out of range.

Allocation_Record

Parameter Type Description
tenantId Integer The tenant ID.
userName String The tenant name.
userDeleted Boolean Whether the capacity allocation records for the tenant are deleted.
  • true: The records are deleted.
  • false: The records are retained.
creator String The name of the tenant creator.
createTime Integer The allocation time, in Unix timestamp format (seconds).
used Integer The assigned capacity.
Note: A value of -1 indicates that the capacity is unlimited.
usedDetails Array<Service_Parameter> The list of assigned capacity details.

Service_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.
paramId String The ID of the parameter.
packageValue Integer The value of the package.
packageUnit String The unit of the package.
  • min
  • day
  • month
  • year
count Integer The count of assigned capacity.
Note: A value of -1 indicates that the capacity is unlimited.
unit String The unit of the parameter.
  • count
  • minute

Example

Request example

GET /uc-subscription/api/v1/subscription/usage/self-colleague?pageSize=10&pageNumber=1&paramKey=users&userName=eve 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": {
    "pageSize": 10,
    "pageNumber": 1,
    "total": 1,
    "results": [
      {
        "tenantId": "2102643004438605826",
        "userName": "jint",
        "userDeleted": false,
        "creator": "DDli",
        "createTime": 1790144132162,
        "used": 2,
        "usedDetails": [
          {
            "paramKey": "users",
            "count": 2,
            "unit": "count"
          }
        ]
      }
    ],
    "totalPages": 1,
    "empty": false
  },
  "requestId": "c3eb28c610c4f0fb0a29d63cfb0bad0e",
  "code": "200",
  "message": "SUCCESS"
}