Agentpool CLI Cheat Sheet

Enter the Agentpool CLI:

chroot /opt/pbxware/pw agentpool -r

Commands:

agent show

(this returns a list with agent states)

agent show 5000

(this returns the agent state for a specific agent, where 5000 is the agent)

api show

(this returns a list with all available API calls)

api subscribe

(this subscribes the CLI to all events, useful for debugging)

api request

(an example of executing an API request)

api request GET /agent/info '{"agent_id": "Agent/5000"}'

(this returns information for a specific agent, where 5000 is the agent)

api request POST /agent/login '{"agent_id":"Agent/5000"}'

(this logs an agent in, where 5000 is the agent)

api request DELETE /agent/login '{"agent_id":"Agent/5000"}'

(this logs an agent off, where 5000 is the agent)

api request POST /agent/hangup '{"agent_id":"Agent/5000"}'

(this hangs up all active calls for an agent, where 5000 is the agent)