Token List

FaxNumber

Fax number as specified by the user Usually devoid of all non-numeric fields

Yes

Yes

Country

Name of the destination country/location

Yes

Yes

TAB

Expands to '4' space characters or nothing

No

No

CRLF

Expands to a end of line sequence

No

No

Status

Either 'Success' or 'Failure'

Yes

Yes

MessageId

Either prefix-job or prefix-job-recipient format

Use FullMessageId

Use FullMessageId

ErrorString

Error String

Yes

Yes

ErrorCode

Error Code

Yes

Yes

ErrorClass

Error Class

Yes

Yes

ErrorExtra

Error Extra

Yes

Yes

Reference Id

The user specified job reference id

Yes

Yes

ReferenceId

Same as above

Yes

Yes

Original Subject

The original subject submitted in the email including tokens that may have been stripped out

No

No

Subject

Subject to appear on the cover page

Yes

Yes

PreProcError

no value specified

n/a

n/a

Original Time

Original email submission time, or the insertion time of the job into the system

No

No

TimeSent

Date/time of the delivery

Yes

Yes

NumPages

Number of Pages

Yes

Yes

CallDuration

Call Duration

Yes

Yes

TestId

Used internally

No

No

StatusId

Either 1 for success, or 2 for failure

Yes

Yes

FaxSpeed

Speed of the fax delivery

Yes

Yes

FullMessageId

as in format 'br�.' with checksums on numbers

Yes

Yes

ErrorResult

Our very small number of errors - error code

Yes

Yes

AccountId

Submission account identifier

Yes

Yes

RemoteCSID

CSID of the remote fax machine (usually it's phone number)

Yes

Yes

Destination

Replaced with contents of user specified notify destination. So the user can specify either a production and staging/beta host name (and :port if needed) OR the user can specify the full URL starting with http and we'll replace the template URL

Yes

No

DeliveredImage

Base64 encoded file contents or "" (empty)

No

Yes

RecptName

Recipient name

Yes

Yes

Company

Company name

Yes

Yes