Skip to main content
GET
/
v1
/
fax
/
status
/
{id}
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: 'My API Key',
});

const response = await client.fax.retrieveStatus('id');

console.log(response.id);
{
  "id": "<string>",
  "status": "queued",
  "provider": "<string>",
  "to": "<string>",
  "from": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deliveredAt": "<string>",
  "errorMessage": "<string>",
  "pageCount": 123,
  "duration": 123,
  "cost": 123,
  "providerData": {}
}

Authorizations

Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Path Parameters

id
string
required

Fax ID returned from the send endpoint

Response

Default Response

id
string
required

Fax identifier

status
enum<string>
required

Current fax status

Available options:
queued,
dialing,
sending,
delivered,
failed,
cancelled,
retrying
provider
string
required

Provider used to send the fax

to
string
required

Recipient fax number

from
string
required

Sender fax number

createdAt
string
required

ISO timestamp when fax was created

updatedAt
string
required

ISO timestamp when status was last updated

deliveredAt
string

ISO timestamp when fax was delivered

errorMessage
string

Error message if fax failed

pageCount
number

Number of pages in the fax

duration
number

Call duration in seconds

cost
number

Cost of the fax

providerData
object

Provider-specific additional data

I