Get Unseen Forward Message Count - OMGTUFMC
Get Unseen Forward Message Count (OMGTUFMC) RI
Required Parameter Group:
1 |
Vehicle Identifier |
Input |
Char(10) |
2 |
Pending Count |
Output |
Packed(7,0) |
3 |
Transmitting Count |
Output |
Packed(7,0) |
4 |
Undeliverable Count |
Output |
Packed(7,0) |
5 |
Received Count |
Output |
Packed(7,0) |
6 |
Return Status |
Output |
Char(1) |
API Overview:
The Get Unseen Forward Message Count API (OMGTUFMC) allows an external application to retrieve counts of various kinds of forward messages that were sent to a vehicle but are as yet unseen by the driver. This API may be thought of as the sister to the Get Unseen Message Counts API which allows an external application to determine how many return messages are unseen for a given user. Alternately, this API returns counts of various kinds of forward messages sent to vehicles that were not read by the driver. Some of these statuses are OK; meaning we believe the driver will eventually read them. Others are errors; meaning the driver will never be able to read these messages because they were undeliverable.
Note: Whether or not a message has been deleted from a vehicle's mailbox has no impact on whether or not it is included in the returned counts.
Required Parameter Group Details:
(1) Vehicle Identifier
INPUT; CHAR(15)
This parameter contains the vehicle id for which to return the unseen forward message counts.
(2) Pending Count
OUTPUT; PACKED(7,0)
This parameter indicates the number of forward messages addressed to the vehicle that have not yet been sent to the NMC for broadcast to the vehicle.
(3) Transmitting Count
OUTPUT; PACKED(7,0)
This parameter indicates the number of forward messages addressed to the vehicle that have been sent to the NMC for broadcast to the vehicle, but have not yet been received by the vehicle.
(4) Undeliverable Count
OUTPUT; PACKED(7,0)
This parameter indicates the number of forward messages addressed to the vehicle that have been sent to the NMC for broadcast to the vehicle and will never be received by the vehicle because some error occurred.
(5) Received Count
OUTPUT; PACKED(7,0)
This parameter indicates the number of forward messages addressed to the vehicle that have been successfully received by the vehicle, but have not yet been read by the driver. Only messages sent with 'Return Receipt' will be included in this count; otherwise there is no way to know if the driver has read the message.
(6) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
0 |
Success, unseen forward message counts returned |
1 |
Failure, vehicle identifier not found |
2 |
Failure, vehicle identifier is blank |
A |
Failure, API failed when called remotely |