getLiveAgentInfo

Description

Retrieves real-time status information for a specific agent. This includes the agent's current activity (e.g., READY, IN CALL,, DISPOSITION, PAUSE - BREAK or LUNCH BREAK,), call details, and campaign context if the agent is handling a live call.

URL - Method POST

POST https://clearnexus.croco-dial.net/goAPIv2/goUsers/goAPI.php

Required Parameters

Parameter	Value	Description
goAction	getLiveAgentInfo	Action to retrieve live status and call info for a specific user.
goUser	MyUser	API authorized user.
goPass	MyPass	Password for the API authorized user.
responsetype	json/xml	Format of the response (json recommended).
user	example.user	The username of the agent to check live info for.

Note: This endpoint uses body parameters for authentication instead of tokens or headers.

Example Request (curl)

curl -X POST https://clearnexus.croco-dial.net/goAPIv2/goUsers/goAPI.php \
  -d "goAction=getLiveAgentInfo" \
  -d "goUser=MyUser" \
  -d "goPass=MyPass" \
  -d "responsetype=json" \
  -d "user=example.user"

  Example Response Agent READY(200 OK)

{
  "result": "success",
  "data": {
    "status": "READY",
    "color": "primary",
    "in_call_with": "",
    "campaign_id": "",
    "campaign_name": "",
    "call_type": "",
    "caller_id": "",
    "conf_exten": "8600118",
    "server_ip": "127.0.0.1",
    "vendor_lead_code": "",
    "lead_id": 0
  }
}

 Example Response Agent IN CALL (200 OK)

{
  "result": "success",
  "data": {
    "status": "IN CALL",
    "color": "green",
    "in_call_with": "1234567890",
    "campaign_id": "CAMP001",
    "campaign_name": "EXAMPLE_CAMPAIGN",
    "call_type": "DIALER",
    "caller_id": "9876543210",
    "conf_exten": "8600118",
    "server_ip": "127.0.0.1",
    "vendor_lead_code": "abc123-xyz456",
    "lead_id": 7890123
  }
}