GetHoldQueueStats

POST

https://api.cbf.tcn.com/services/callmonitor/v1alpha1/getholdqueuestats

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "org_id": "string",
    "start_time": "1s",
    "end_time": "1s",
    "filter": {
        "status": "HOLD_QUEUE_MONITOR_STATUS_UNSPECIFIED",
        "campaign_id": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/services/callmonitor/v1alpha1/getholdqueuestats' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "org_id": "string",
    "start_time": "1s",
    "end_time": "1s",
    "filter": {
        "status": "HOLD_QUEUE_MONITOR_STATUS_UNSPECIFIED",
        "campaign_id": "string"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "stats": [
        {
            "call_id": "string",
            "org_id": "string",
            "campaign_id": "string",
            "phone_number": "string",
            "status": "HOLD_QUEUE_MONITOR_STATUS_UNSPECIFIED",
            "monitor_duration_millis": 0,
            "monitor_start_time": "1s",
            "monitor_end_time": "1s"
        }
    ],
    "total_num_calls": 0,
    "total_num_successful": 0,
    "total_num_failed": 0,
    "avg_monitor_duration_ms": 0,
    "total_num_monitoring": 0
}

🟢200Success

Modified at 2025-09-26 15:44:58

EvaluateBusinessHours

DequeuePreviewRecordOrCall