Since July 6, 2023, Atlassian has no longer been used for Release Notes or knowledge base articles.
* Find Release Notes here (https://support.mycontactcenter.net/app/articles/detail/a_id/23378/) and articles here (https://support.mycontactcenter.net/app/main).
* Authenticated Partners can access content here (https://support.mycontactcenter.net/cc/sso/authenticator/oauth/authorize/imcontrolpanel?redirect=main&source=mycontactcenter)


Retrieving the list of active agents

This method retrieves the list of active agents within the account and that are available to the user account that was used when opening the API session by invoking OpenSession method.
Method Signature:
GetAgentsResponse GetAgents(string sessionId);
Parameters:

Parameter Name

Description

sessionId

ID of the session opened by invoking OpenSession method


The method returns an object of type "GetAgentsResponse" that contains the following fields:

Field Name

Type

Description

ErrorCode

Integer

Error code describing the outcome of the operation (0 = Success)

Description

String

Message describing the error condition if applicable

Agents

List

A list of objects of type "BasicAgentInfo" containing the ID, username, first name, and last name of each agent


Note:

  • It is recommended to use an "Administrator" user account when opening the session to ensure all active agents within the account are included in the list.



Since July 6, 2023, Atlassian has no longer been used for Release Notes or knowledge base articles.
* Find Release Notes here (https://support.mycontactcenter.net/app/articles/detail/a_id/23378/) and articles here (https://support.mycontactcenter.net/app/main).
* Authenticated Partners can access content here (https://support.mycontactcenter.net/cc/sso/authenticator/oauth/authorize/imcontrolpanel?redirect=main&source=mycontactcenter)