Query Concurrent Call Statistics

Query real-time concurrent call statistics for Dashboard display, grouped by call state with optional tenant filtering.

Request URL

POST {base_url}/uc-ccontrol/api/v1/call-sessions/concurrent-stats

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Body parameters
Parameter Required Type Description
states No Array<String>

The call states used to filter the statistics.

Valid value:

  • talking
  • ringing
  • queueing
Note: If this parameter is empty or not specified, statistics for all three states are returned.
tenantCodes No Array<String> The tenant name used to filter the statistics by tenant.
Note: You can obtain tenant name 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<Concurrent_Call_Status> The concurrent call statistics.
Concurrent_Call_Status
Parameter Type Description
groups Array<Status> The statistics grouped by call state.
Status
Parameter Type Description
state String

The concurrent call status.

  • talking
  • ringing
  • queueing
total String The total number of concurrent calls in this state.
byTenant Array<Tenant_Details> The concurrent call statistics for each tenant.
Tenant_Details
Parameter Type Description
key String The tenant name.
inbound String The number of concurrent inbound calls.
outbound String The number of concurrent outbound calls, including emergency outbound calls.
internal String The number of concurrent internal calls.
emergency String The number of concurrent emergency outbound calls.
total String The total number of concurrent calls.

Example

Request example

POST /uc-ccontrol/api/v1/call-sessions/concurrent-stats HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjA2ODk2OSwiaWF0IjoxNzkyMDQ3MzY5LCJqdGkiOiJlY2U4ZTQ3Zi03OGI1LTRjZDQtOWVkNC03MGM3MTM2MTFkYzAiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.HhpJ477TZxosYnWaMEUPegGHwg8ZvCDzyY8nDeb27GHF60l__HfEr60gfy4JVaePAlr0GeGezX2WjjsOZoxMwUnNog5g3L2A2i254QHwlejSGByn_sNvltuD85e4Sfhao657lDoP1-wo_kTBo2e8kB-wQs7WgjqKIk6fKko9S7WvRn751wjxKPZtU2F1yn--m40RHUyz22eM6fOppzet3z0igX7APM8qCyRXBiuNzsrrRd9RkE34xZHc3yXoPeX1DX1VgtVM_T7YvtXCNMR4zqg6Yd-FES_Q4baUHpHGQza47QKoVWUha1bxs3rHD-GTRi8_OGm8qh3M0AyRK5007g
Content-Type: application/json
{
  "states": [
    "talking",
    "ringing",
    "queueing"
  ],
  "tenantCodes": [
    "jint"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "0677e3b98f21ebb035e957a7677fe7fb",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "groups": [
      {
        "state": "talking",
        "total": "1",
        "byTenant": [
          {
            "key": "jint",
            "inbound": "0",
            "outbound": "0",
            "internal": "0",
            "emergency": "0",
            "total": "0"
          }
        ]
      },
      {
        "state": "ringing",
        "total": "0",
        "byTenant": [
          {
            "key": "jint",
            "inbound": "0",
            "outbound": "0",
            "internal": "0",
            "emergency": "0",
            "total": "0"
          }
        ]
      },
      {
        "state": "queueing",
        "total": "0",
        "byTenant": [
          {
            "key": "jint",
            "inbound": "0",
            "outbound": "0",
            "internal": "0",
            "emergency": "0",
            "total": "0"
          }
        ]
      }
    ]
  }
}