AgentGetStatus

POST

https://api.cbf.tcn.com/api/v0alpha/acd/agentgetstatus

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "session_sid": 0,
    "perform_keep_alive": true
}

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/v0alpha/acd/agentgetstatus' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_sid": 0,
    "perform_keep_alive": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "status": 0,
    "status_desc": "UNAVALIABLE",
    "paused": true,
    "queue": "string",
    "current_session_id": 0,
    "last_status_change": 0,
    "monitoring": true,
    "calls_count": 0,
    "last_sip_code": 0,
    "agent_peer_is_lost_call": true,
    "disabled": true,
    "keep_alive_succeeded": true,
    "transfer_members": [
        {
            "agent_session": {
                "agent_sid": 0,
                "tenant_sid": 0,
                "session_sid": 0,
                "asm_session_sid": 0,
                "org_id": "string",
                "region_id": "string",
                "user_id": "string"
            }
        }
    ],
    "agent_is_muted": true
}

🟢200Success

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

AgentGetStatusStream

AgentGetConnectedParty