GetCampaignCompletionStatus

POST

https://api.cbf.tcn.com/api/v1alpha1/p3api/getcampaigncompletionstatus

Gets all running broadcasts (task groups) for the requesting agent and hunt_group_sid in the request.
Calculates the percentage of completed tasks for each of those task groups.
Calculates the overall task completion percentage of all matching task groups.
Required permissions:
NONE
Errors:

grpc.Invalid: the hunt_group_sid in the request is invalid.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "hunt_group_sid": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/p3api/getcampaigncompletionstatus' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hunt_group_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "broadcasts_exist": true,
    "percent_complete": 0,
    "completion_status": {
        "property1": {
            "task_group_sid": 0,
            "name": "string",
            "percent_complete": 0,
            "total_tasks": 0,
            "total_tasks_completed": 0
        },
        "property2": {
            "task_group_sid": 0,
            "name": "string",
            "percent_complete": 0,
            "total_tasks": 0,
            "total_tasks_completed": 0
        }
    },
    "total_tasks": 0,
    "total_tasks_completed": 0
}

🟢200Success

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

ListAgentTriggers

GetLostPeerInfo