Skip to main content
Version: v4 (Stable)

AddUser

AddUser(ListType As Integer, ListId As Integer/String, UserId As Integer/String[, Relief As Boolean[, Position As Integer]]) As Boolean

This function adds a user in a call group or a team.

  • <ListType> = 3 to add a user to a group, = 6 to add a user to a team.
  • <ListId> = object id of the list (group or team) if integer type, object name (group or team) if string type.
  • <UserId> = user id if integer type, user name if string type.
  • <Relief> = optional parameter (FALSE by default), TRUE if the user is defined as relief user.
  • <Position> = optional parameter giving the position of the user in the list, with 0 for 1st position, -1 for last position.

If the user already exists in the list, the new relief status (if defined) is assigned and, if the position is defined, he is moved to the new position.

Returns TRUE if all is right.