Group 3 fax
Group 3 is the class of fax terminal that ITU-T T.4 standardizes. Group 3 terminals send black and white documents, and optionally colour ones, over the general switched telephone network. ITU-T T.30 defines the procedures they use.
Fax and fax API glossary
Updated
Nineteen terms from fax and from the Fax for Agents API. Each one has two or three sentences you can quote. Under it is the source we checked it against and the day we read it.
An entry states only what the source named under it says. Protocol terms come from ITU-T pages. API terms come from our own documentation and the OpenAPI file.
Cite this page: Fax for Agents, "Fax and fax API glossary", https://faxforagents.com/glossary/, last updated . To cite one term, add its anchor to that address, as in #partial.
Fax protocol terms
ITU-T T.4
ITU-T T.4 is the recommendation that defines the characteristics of Group 3 fax terminals. Its title is "Standardization of Group 3 facsimile terminals for document transmission". The edition in force is 07/2003, approved on 2003-07-14.
ITU-T T.30
ITU-T T.30 defines the procedures that Group 3 fax terminals use to send a document. The procedures cover the general switched telephone network, international leased circuits and ISDN. The edition in force is 09/2005, approved on 2005-09-13.
ITU-T T.38
ITU-T T.38 defines the procedures for Group 3 fax when part of the path between the terminals is an IP network. Its title is "Procedures for real-time Group 3 facsimile communication over IP networks". The edition in force is 11/2015, approved on 2015-11-29.
Error correction mode (ECM)
Error correction mode, ECM, is an optional mode of Group 3 fax. ITU-T T.4 lists it as Annex A, "Optional error correction mode". ITU-T T.30 gives the procedure in its Annex A, for Group 3 transmission "incorporating error correction".
Standard and fine resolution
Standard and fine are two fax resolutions. Standard is 204 by 98 dpi and fine is 204 by 196 dpi. In the Fax for Agents API, a quote's quality field takes standard, fine, superfine or ultra, and fine is the default.
CSID
CSID stands for called subscriber identification. ITU-T T.30 abbreviates it CSI and defines it as an optional signal from the called terminal to the calling one. The signal carries the called subscriber's international telephone number in a field of 20 digits.
Fax for Agents API terms
The API has six job states: queued, active, partial, failed, unknown and delivered. The names come from the FaxJob.state enum in openapi.json.
Job state
A job state tells your application what happened to a fax job. A send answers 201 with a job in queued. What happens after is a state on the job, carried by events and webhooks, not an HTTP error.
queued
A job in queued was accepted and is waiting for the worker. The quoted amount is held in the wallet.
active
A job in active is with the provider, and attempts are in progress. Busy and no answer are retried up to three times. The amount stays held.
partial
A job in partial had some pages confirmed and not the rest. The confirmed pages are captured and the rest of the hold is released. The service never retransmits a partial job on its own.
failed
A job in failed ended unsuccessfully, with no send charge. The cause is exhausted attempts, an invalid number, a render failure or a cancel, and failure_code says which. The hold is released.
unknown
A job in unknown has no outcome by the deadline. The hold stays while the reconcile tick keeps asking the provider. The service never retransmits an unknown job on its own.
delivered
A job in delivered had every page confirmed, with the evidence stored on the attempt. The held amount is captured. The state says nothing about whether a person read the document.
Idempotency key
An idempotency key is a value you send in the Idempotency-Key header of a mutating call. Retry after a timeout with the same key and you get the same job. A different body under the same key is a 409.
Quote
A quote gives you a price before you send. POST /v1/fax-quotes prices one document for one destination. The quote fixes the destination, sender number, pages, cover sheet and amount for ten minutes.
Approval
An approval is a person's yes to one exact send. It covers one document hash, one destination, one sender, one amount and an expiry. Any change invalidates it.
Delegated policy
A delegated policy is a set of limits an administrator writes once. Every send under it is evaluated on the server from the quote and the document row. Nothing an agent writes is an input, so a prompt cannot move a limit.
Sandbox
The sandbox takes every send made with a test key. There is no carrier and no cost, and nothing leaves the box. The outcome is decided by the destination number or by a scenario you select.
How we check a term
For a protocol term we open the recommendation's page on itu.int and write down what it says. Most entries come from the summary of the edition in force. Error correction mode comes from the contents pages, because the summaries do not name it. CSID comes from two numbered clauses of T.30. The resolution entry cites our own send page, because the T.4 summary lists no values.
For an API term we copy the wording of the page named under it. The job state names are read from openapi.json, and our build fails when this page and that file differ.
If an entry no longer matches its source, tell us through the contact page and name the anchor.