chickadee » efax » efax-status

(efax-status [account: ACCOUNT] [username: USERNAME] [password: PASSWORD] [doc-id: DID] [transmission-id: TID])procedure

Fetch the status of a message previously sent with efax-send (or other means). You can either pass DID, which should be the eFax document id (document-id in the alist returned by efax-send) or your own transmission identifier (transmission-id in the alist returned by efax-send, which is the TID you passed in yourself).

This will return an alist which currently has two keys: transmission-id and recipients. transmission-id is simply the transmission ID of the message, or #f if you didn't provide one when sending it. recipients is a list of pairs, the cars of which are fax numbers (strings) and the cdrs of which are alists with the following keys (all values are strings):

name (optional)
The name of the recipient as specified in efax-send.
company (optional)
The company of the recipient as specified in efax-send.
fax
The fax number again
status-message
A human-readable message indicating the message's current status.
status-classification (optional)
A value indicating the message's status "classification".
status-outcome (optional)
Another value like status-classification. The difference is unclear from the documentation. In success cases both status-classification and status-outcome have "Success" as a value.
last-attempt-date (optional)
The date of the last transmission attempt.
last-attempt-time (optional)
The time of the last transmission attempt.
next-attempt-date (optional)
The date when the next transmission attempt will take place, if the message hasn't been successfully transmitted and eFax hasn't given up yet.
next-attempt-time (optional)
The time when the next transmission attempt will take place.
pages-scheduled (optional)
The number of pages that were scheduled for transmission.
pages-sent (optional)
The number of pages that were actually sent.
baud-rate (optional)
The baud rate used for the transmission.
duration (optional)
Duration in minutes for the transmission.
retries (optional)
Number of retries for the transmission.
remote-csid (optional)
The CSID transmitted to.