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

const client = new BlueHive({
  apiKey: process.env['BLUEHIVE_API_KEY'], // This is the default and can be omitted
});

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

200
application/json

Default Response

The response is of type object.