Skip to main content
Version: v4 (Stable)

SendUserMessage

SendUserMessage(UserId AS Integer, AlphaMessage AS String[, NumMessage AS String[, AudioFile AS String[, Instructions AS String[, Flags As Integer]]]]) AS Integer

Sends a service message to the user designated by the <UserId> ID (numeric identifier or user name).

The sent message is defined by the following parameters:

  • <AlphaMessage>: the long alphanumeric message
  • <NumMessage>: the short message (optional)
  • <AudioFile>: the name of the audio file associated with the message (optional)
  • <Instructions>: the name of the instruction file associated with the message (optional)

The optional <Flags> parameter can define a bit mask specifying the desired or forced media:

  • &h0000 = default
  • &h0001 = beep
  • &h0002 = vocal
  • &h0004 = SMS
  • &h0008 = pager
  • &h0010 = fax
  • &h0020 = email
  • &h0040 = printer
  • &h0100 = AlertMobile
  • &h8000 = Forced Media

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