Developer Zone

ReachOut™ direct-to-desktop messaging service

From the online customer area you can create ReachOut™ messaging campaigns which are used to deliver messages or surveys directly to the desktop of users who are running your software. You may choose a specific target audience for your message by defining a set of delivery filters so that each message will be delivered only to those users who match the specified criteria (such as geographical region, edition, version, build, language, OS, license status, runtime duration, days since install, etc.)

When building a ReachOut™ campaign you can choose between 2 message delivery options.

  • Automated HTML popup messages (which is handled entirely by the Trackerbird library and requires absolutely NO coding.
  • Manually retrieving the message (plaintext or URL) through code by using the messageCheck() function.

Manual Message Retrieval

When you want full control on when and where in your application to display a ReachOut™ message to your users, you can define ReachOut™ messages of the type plain text or URL. Then from within your application you can call one of the below functions to check with the Trackerbird server whether there are any pending messages (of this type) waiting to be delivered.

You may choose to display plaintext messages anywhere in your application such as in a status bar or information box. For the URL type messages you can either open the URL in a browser or else render it in some HTML previewer embedded within your application.

messageCheck([messageType=0])

This function requests a manual ReachOut™ message from the server. This can be either a plain text message or a URL, depending on what messages are waiting on the server or what is specified by the developer. By default, the messageType parameter is set to 0 which refers to “any format”. The possible message types are 1 for plain text and 2 for URL.

Parameters:messageType (int) – This value is filled by the developer and should contain the type of message that is being requested. This must be one of the message types described above.
Return type:Tuple in the format (<Status or Message Count>, <Received Message Type>, <Message Text>)
Status or Message Count:
If 0 or greater, it contains the number of messages remaining on the server. Otherwise, one of the return status codes below:
* FUNCTION_NOT_AVAIL (-1)
* CONN_ERROR (-2)
* AUTH_FAILURE (-3)
* SERVER_ERROR (-4)
* APP_CONFIG_NOT_LOADED (-7)

Received Message Type:

* MESSAGETYPE_TEXT (1)
* MESSAGETYPE_URL (2)
* -1 (No messages available)
Message Text:
Unicode value containing the message text or URL

Code Example:

messageRet = Trackerbird.messageCheck(1)
if messageRet[0] > 0:
    print("This is your message: " + messageRet[2])
else:
    print ("No messages")