Appendix B: Message Tokens
Message tokens resolve dynamic transmission values from a specific inbound or outbound fax (e.g., page counts, transmission durations, caller IDs, error codes). Message tokens begin with the prefix MESSAGE. and can be used in delivery templates and custom cover pages.
Tokens marked as (MULTI-VALUED) can be indexed using the Token Extended Syntax.
Core Message Tokens
| Token Name | Description |
|---|---|
$$MESSAGE.ID$$ |
Unique internal message identifier |
$$MESSAGE.NUMBER$$ |
Formatted message sequence number |
$$MESSAGE.STATUS$$ |
Overall transmission status string |
$$MESSAGE.IS_SUCCESS$$ |
Boolean status indicator |
$$MESSAGE.IS_OUTBOUND$$ |
Indicates whether transmission is inbound or outbound |
$$MESSAGE.SUBJECT$$ |
Message subject line |
$$MESSAGE.NOTE$$ |
Cover page notes / body narrative |
$$MESSAGE.BILLING_CODE$$ |
Billing or project code associated with message |
$$MESSAGE.REFERENCE_NUMBER$$ |
External application reference number |
$$MESSAGE.TRACKING_KEY$$ |
Custom tracking key value (MULTI-VALUED) |
$$MESSAGE.BARCODE$$ |
Extracted document barcode data (MULTI-VALUED) |
$$MESSAGE.RECIPIENT_LIST$$ |
Comma-delimited recipient list (MULTI-VALUED) |
$$MESSAGE.FROM_NAME$$ |
Sender display name |
$$MESSAGE.FROM_COMPANY_NAME$$ |
Sender company name |
$$MESSAGE.CREATE_DATE$$ |
Message creation date |
$$MESSAGE.CREATE_TIME$$ |
Message creation time |
$$MESSAGE.CREATE_DATE_TIME$$ |
Full message creation timestamp |
$$MESSAGE.DATE$$ |
Scheduled execution date |
$$MESSAGE.DATE_TIME$$ |
Scheduled execution timestamp |
$$MESSAGE.APPROVAL.DESC$$ |
Workflow approval description narrative |
$$MESSAGE.APPROVAL.REPLY$$ |
Approver reply comments |
$$MESSAGE.OWNER_USER_ID$$ |
Originating owner user ID |
$$MESSAGE.OWNER_USERNAME$$ |
Originating owner login username |
$$MESSAGE.OWNER_DOMAIN_ID$$ |
Originating domain ID |
$$MESSAGE.OWNER_DOMAIN_NAME$$ |
Originating domain name |
Transaction & Telephony Tokens (MESSAGE.XSACT.*)
| Token Name | Description |
|---|---|
$$MESSAGE.XSACT.TRANSACTION_ID$$ |
Specific transmission attempt ID |
$$MESSAGE.XSACT.ATTEMPT_COUNT$$ |
Total retry attempts made |
$$MESSAGE.XSACT.STATUS$$ |
Transaction state status |
$$MESSAGE.XSACT.IS_SUCCESS$$ |
Transaction success boolean |
$$MESSAGE.XSACT.COMPLETE_DATE$$ |
Completion date |
$$MESSAGE.XSACT.COMPLETE_TIME$$ |
Completion time |
$$MESSAGE.XSACT.COMPLETE_DATE_TME$$ |
Full completion timestamp |
$$MESSAGE.XSACT_PAGE_COUNT$$ |
Total document page count |
$$MESSAGE.XSACT.NUMBER_PAGES_SENT$$ |
Number of pages successfully transmitted |
$$MESSAGE.XSACT.ADDRESS_FORMAT_TYPE$$ |
Output format extension (PDF or TIF) |
$$MESSAGE.XSACT.DISPLAY_ADDRESS$$ |
Display recipient destination |
$$MESSAGE.XSACT.IMAGE_PATH$$ |
Internal storage path of the document image |
$$MESSAGE.XSACT.RECIPIENT_NAME$$ |
Recipient contact name |
$$MESSAGE.XSACT.RECIPIENT_COMPANY_NAME$$ |
Recipient organization name |
$$MESSAGE.XSACT.XMIT.AGENT_ID$$ |
FaxAgent server ID that handled the transmission |
$$MESSAGE.XSACT.XMIT.PORT_NO$$ |
Physical/virtual port channel used |
$$MESSAGE.XSACT.XMIT.SERVER_NAME$$ |
Host server name |
$$MESSAGE.XSACT.XMIT.CALLED_NUMBER$$ |
Destination telephone number dialed |
$$MESSAGE.XSACT.XMIT.CALLER_ID$$ |
Remote Caller ID received |
$$MESSAGE.XSACT.XMIT.REMOTE_CSID$$ |
Remote CSID reported by answering terminal |
$$MESSAGE.XSACT.XMIT.ROUTE_DIGITS$$ |
Inbound DTMF / DID digits captured |
$$MESSAGE.XSACT.XMIT_CALL_TIME$$ |
Telephony connect duration in seconds |
$$MESSAGE.XSACT.XMIT_TIME$$ |
Formatted total transmission duration |
$$MESSAGE.XSACT.XMIT_ERROR_ID$$ |
Numeric telephony error code |
$$MESSAGE.XSACT.XMIT_ERROR_DESC$$ |
Human-readable error description |
$$MESSAGE.XSACT.XMIT_ERROR_INFO$$ |
Detailed telco diagnostic information |