Fleet Connectivity Extension API Developer's Guide

check_messages

Use the resource check_messages when the dispatcher awaits updates from assets. A response is generated as soon as messages for the dispatcher are available.

This resource offers a more efficient mechanism than repeated polling via listupdates: submit a request to check_messages and when a response arrives, use listupdates.

Note that an error response may be generated before updates become available, for example, due to timeouts. Should this occur, ensure that the dispatcher resubmits the request to check_messages.

Success responses to a request to this resource do not contain messages. I merely indicates that the dispatcher needs to submit a request to listupdates to retrieve messages.

This resource supports GET requests.

Resource URI

The pattern for requests to the resource is base-url/1/check_messages.json?<parameter>=<value>. For more information, see Constructing a Request.

Resource Parameters

Parameter Type Mandatory Description
app_id string Y

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

app_code string Y

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

recipient_id string N

Only return the update messages for this dispatcher or asset.

callback string N

Specifies the name of a user-defined function used to wrap the JSON response. Required for JSONP requests.

Default: No JSONP response wrapper

last_update_timestamp_ms integer N

Only consider the update messages whose creation_time is not before the given timestamp. This filter is AND-combined with the other filter parameters.

Check Messages Response

A success response from this resource contains an empty message.