getTeamMembers
Get a list of all members of a specified team
Request
Syntax
| getTeamMembers(teamId: string): Promise<OperationResult<TeamMember[]>> |
Where:
| type TeamMember = {
id: string teamId: string firstName: string lastName: string phone: string state: TeamMemberState } type TeamMemberState = "offline" | "ready" | "not ready" | "busy" | "after call work" | "supervising" |
Parameters
(None)
Example Request
getTeamMembersButton.onclick = () => {
const teamId = teamIdInput.value
adApi.getTeamMembers(teamId)
}
Return Value
| Object | Object Values | Data Type | Optional?
(Y/N) |
Return Value Description |
| TeamMember | ||||
| id | String | N | The team member’s unique (user) ID | |
| teamId | String | N | The team’s unique ID | |
| firstName | String | N | The team member’s first name | |
| lastName | String | N | The team member’s last name | |
| phone | String | N | The team member’s assigned phone number (i.e., extension) | |
| state | String | N | Returns the team member’s state as one of the following values:
|
Explanation of States
Offline- The user is offline and not available to handle interactions.
Ready- The user is ready to handle interactions.
Not ready- The user is not ready to handle interactions.
Busy- The user is unavailable to accept new interactions because they are already handling one or more interactions.
After call work- The user is unavailable to accept service interactions because they are currently processing information related to an interaction that they previously handled.
Supervising- The user is supervising other agents and will not receive any service interactions while they are in this state.
|
Business users who do not take part in handling automatically distributed interactions cannot have the "busy" state. | |