Skip to main content
Version: v4 (Stable)

GETNEXTALARMMESSAGE

GETNEXTALARMMESSAGE(userid AS INTEGER, flags as INTEGER, alarmid AS INTEGER, message AS STRING [, langid AS INTEGER [, alarmtime as TIME [, audiofile AS STRING [, instructions AS STRING [, shortmessage AS STRING]]]]]) AS BOOLEAN

Returns the next alarm message to transmit to the user identified by <userid>.

When processing an outgoing call, the parameter <userid> can be defined with a null value to designate the called user.

The parameter <flags> is reserved and must be set to 0. The alarm identifier is returned in <alarmid>. The long alarm message is returned in <message>. The message language is returned in <langid>. The alarm time is returned in the optional parameter <alarmtime>. The audio file is returned in the optional parameter <audiofile>. The instructions are returned in the optional parameter <instructions> (file name). The short message is returned in the optional parameter <shortmessage>.