Skip to main content
Version: v4 (Stable)

GetUserDuty

GetUserDuty(UserId As Integer/String, ReplaceUserId As Integer [, CallGroupId As Integer/String]) As Integer

This function returns the duty status of the user <UserId> (numerical ID or user name).

The duty status of user is returned in <ReplaceUserId>:

  • 0 = user is on duty
  • -1 = user is off duty
  • 0 = id of the substitute user

If the optional parameter <CallGroupId> contains the name or id of a call group, then the duty status of the user only concerns this call group.

Returns an error code (0 if no error, 8 if invalid user ID).