Send an IM with UCWA - Hints, Tips & Extra Goodies - Learn More

Keep Alive

UCWA will automatically shut down Applications and Conversations after a few minutes, if it does not receive a 'Keep Alive' signal from the client in a timely fashion. Whilst any IM or other activity will trigger this cycle, in circumstances where there are no IM's being sent frequently, a 'Keep Alive' must be sent to maintain an active application.

In my experience, I've found sending this 'Keep Alive' every 3 minutes (180 seconds) during idle times is sufficient.

Triggering a Keep Alive is performed by a single POST to the interface.

POST /ucwa/oauth/v1/applications/12345678/me/reportMyActivity

No POST data is required.

HTML messages

By default, UCWA will send Instant Messages as plain text. You can, however, add HTML as a modality in order to send rich text messages via IM.

This is achieved by a single POST to the interface.

POST /ucwa/oauth/v1/applications/12345678/me/makeMeAvailable

With the POST data being:

{"SupportedModalities":["Messaging"],"supportedMessageFormats":["Plain","Html"]}

Tags