API Command: get_connected_client_list

The get_connected_client_list command returns XML data containing a summary or list of all connected Bomgar clients.

In order to issue the get_connected_client_list command, you will need to supply the username and password for a Bomgar user account. That account must have the permission Allowed to Use Command API.

Optional Parameters for get_connected_client_list

type=[string]

The types of clients to return in the results. Can be a comma-separated list of values. Supported values are all (default), representative, support_customer, presentation_attendee, and push_agent.

Note: Currently, pinned_client is not a possible value. If the count of pinned Jump Clients is needed in the summary, then all must be specified.

summary_only=[boolean] To return only a summary, set this to 1.

XML Response for get_connected_client_list

<connected_client_list> Contains a <connected_client_summary> element with a summary of the data. Also contains a <connected_client> element for each client currently connected to the appliance. If an error occurs, it will contain an <error> element describing the problem.

Element Names and Attributes

/connected_client_list/connected_client_summary
<appliance_summary>

An <appliance_summary> element is created for each connected appliance.

/connected_client_list/connected_client_summary/appliance_summary
id (attribute)

The appliance's GUID.

<count> A <count> element is created for each type of client connected to this appliance.
/connected_client_list/connected_client_summary/appliance_summary/count
type (attribute)

The type of client connected to the appliance. Can be one of representative, support_customer, presentation_attendee, push_agent, or pinned_client.

/connected_client_list/connected_client
type (attribute) The type of client connected to one of the clustered appliances. Can be one of representative, support_customer, presentation_attendee, or push_agent.
id (attribute) A unique identifier which remains valid only while the client is connected.

Query Examples: get_connected_client_list

Get a list of all connected clients https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list
Get a list of all connected representatives https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list&type=representative
Get a list of all connected representatives and support customers https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list&type=representative,support_customer
Get a summary of all connected clients https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list&summary_only=1
Get a summary of all connected representatives https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list&summary_only=1&type=representative
Get a summary of all connected representatives and support customers https://support.example.com/api/command?username=test&password=test&action=get_connected_client_list&summary_only=1&type=representative,support_customer