Document toolboxDocument toolbox

Instant messages commands

The old messages system. Replaced by Messaging system.

SendMessage

Send a message to Microbizz.

Input

messagestringThe message text
remoteidnumberThe ID of a Microbizz user who should receive the message
confirmationbooleanIf the message requires confirmation from the receiver
replytoidnumberThe ID of a message that this is a reply to

Output

idnumberThe ID of the newly created message

If replytoid is set then remoteid is ignored, as the receiver is implied from the original message.

ConfirmMessage

Confirm a message.

Input

messageidnumberThe ID of the message

Output

None--

GetMessagesByLastChange

Get all messages for the current user, and possibly mark some messages as read

Input

changedatedate-
changetimetime-
pushtokenstringThe push token to use; this may also be specified in the main envelope for the commands
readcollection[number]List of message IDs to be marked as read
unreadcollection[number]List of message IDs to be marked as not read

Output

messagescollection [ message ]The messages
confirmedcollection[number]The message IDs of the messages confirmed since last GetMessagesByLastChange