Status Operational Status

Send Message

  • Last edited on

 Use this call to send a message to a driver logged into a Zonar tablet device.

Request Data

Required Information
Name Description
action twentytwenty
operation sendmessage
format xml
version 2

This call is only available in version 2 of the API.
target The driver identifier for the destination of the message
reqtype Flag to identify the key being used to identify the driver. Acceptable values:
  • tag Key is a Driver's (Operator) Zonar RFID tag number. In version 2.X a type must also be specified.
  • exsid Key is the external system id.
  • dbid Key is the internal database id number. This is the most reliable key to use.
form The form number being sent
data The form data.

This should be url-encoded to account for any special characters that may be transmitted.
provider The name of the message provider
messageid The message id from the providers system
Optional Information
timestamp The timestamp to mark the message origination time.

If no value is passed, the current time will be used.
dataformat Special payload encoding format for the data parameter used in certain integrations, ex. 'base64'.

Plain text and URL encoding do not require this field.

Example Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=twentytwenty&operation=sendmessage &format=xml&version=2&target=1&reqtype=dbid&form=0&data=Test%20freeform%20data &provider=zonar&messageid=1234&timestamp=1383156739

Data Returned

A success or error message.

Example Success Reply XML

<?xml version="1.0"?>
<success ver="2">
 <action>twentytwenty</action>
</success>

Messages