BLbluehive-health
Fax Services

Fax Status

Retrieve the current status and details of a fax by its ID.

get/v1/fax/status/{id}

Request

Path parameters

idstring required

Fax ID returned from the send endpoint

Response

Default Response

idstring required

Fax identifier

status'queued' | 'dialing' | 'sending' | 'delivered' | 'failed' | 'cancelled' | 'retrying' required

Current fax status

providerstring required

Provider used to send the fax

tostring required

Recipient fax number

fromstring required

Sender fax number

createdAtstring required

ISO timestamp when fax was created

updatedAtstring required

ISO timestamp when status was last updated

deliveredAtstring

ISO timestamp when fax was delivered

errorMessagestring

Error message if fax failed

pageCountnumber

Number of pages in the fax

durationnumber

Call duration in seconds

costnumber

Cost of the fax

providerDataobject

Provider-specific additional data

Changes

No recorded changes to this operation across all 55 revisions of this API.