Skip to main content
Version: v4 (Stable)

RemoveUser

RemoveUser(ListType As Integer, ListId As Integer/String[, UserId As Integer/String]) As Boolean

This function removes the user <UserId> from a call group or a team. <UserId> can be the numeric object id of the user or his name, according with the parameter type (Integer or String).

<ListType> defines the type of container:

  • = 3 to remove a user from a group
  • = 6 to remove a user from a team

<ListId> = object id of the container (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. If this parameter is omitted, all the users of the container (group or team) are removed.

Returns TRUE if all is right.