GET /uccx/agentstate

Get an Agent State record from the CallCenterAutomation database based on the agent id. Please note that this is an application specific api method that can also do an insert or an update. While this breaks REST principles it is necessary for maintaining API compatibilitiy with a legacy application.


The response model is returned without a wrapper

  "id":         "Integer - table pk",
  "agent_id":   "String - username",
  "agent_name": "String - full name of agent",
  "queue_name": "String - name of queue",
  "team":       "String - name of team the agent is assigned to",
  "state":      "String - the agent state",
  "clevel":     "Integer - agent competence level",
  "ani":        "Integer - ANI the agent is currently engaged with",
  "created_at": "Datetime - record creation datetime",
  "updated_at": "Datetime - record modification datetime"

Resource URL{response_format}



Response Format



agent_id - required
Username of agent.
agent_name - required
Given Name of agent.
team - required
Team agent resides in.
state - required
Agent's current state.
ani - optional
The ANI associated with the event if there is one
jsonp_callback - optional
If making cross domain Ajax calls use this as the call-back method name in your Ajax request.

HTTP Errors

  "error": {
    "code": 400,
    "message": "Bad request (if set by the developer, specific reason for bad request)"
  "error": {
    "code": 404,
    "message": "Not found"
  "error": {
    "code": 500,
    "message": "Internal Server Error"