5.19:AgentDesktop-client-side-javascript-api-specification/getTeamMembers

• 5.19

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" | "available" | "dnd" | "away" | "busy"

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: "offline" "available" "dnd" "away" "busy"

< Previous | Next >