Skip to main content
Omnitracs Knowledge Base

CC Additional Recipients on a Return Message - OMCCRMSG

CC Additional Recipients on a Return Message (OMCCRMSG) RI

Required Parameter Group:

1

Global Message Handle

Input

Packed(9,0)

2

CC Recipient

Input

Char(10)

3

Return Status

Output

Char(1)

4

Reason Code

Output

Char(4)

API Overview:
The CC Additional Recipients on a Return Message API (OMCCRMSG) allows external applications to carbon copy additional recipients on return text messages. This API does not override existing coverages (neither macro coverage nor vehicle coverage); rather it supplements the existing coverages. This API does not create or copy a new message; rather, it merely adds additional recipients to the existing message. Of course, this API handles duplicate addressee detection, redirection, and notification.
Some sites require some return text messages to be routed to one or more additional users. This API is the recommended technique for handling return message coverage that is outside the scope of the QTRACS base product. This API is much preferred over using the OMERTR stub. It is meant to be called from within the Return Macro Handler (e.g. OMNIX).
See the deliverable source module OMEXA001 for a sample of a return macro handler that calls OMCCRMSG.

Required Parameter Group Details:
(1) Global Message Handle
INPUT; PACKED(9,0)
This parameter must contain the unique global message handle of a valid return text message.

(2) CC Recipient
INPUT; CHAR (10)
This parameter must contain the name of a user or an address list. The user (or members of an address list) specified here will have a copy of the specified message delivered to their mailbox.

(3) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:

0

Success, forward message cancelled

1

Failure, see reason code

A

Failure, API failed when called remotely

(4) Reason Code
OUTPUT; CHAR(4)
This parameter contains a reason code. Possible values returned include;

0000

OK

0001

Global message handle not found in QTRACS database

0002

Global message handle is not a return message

0003

CC recipient is not a valid entity

0004

CC recipient is not a user or address list

Effect
Calling this API from some external application will result in the delivery of a copy of the specified return text message to the mailbox of each of the specified users.

  • Was this article helpful?