Faxes | SignalWire

Manage faxes with CRUD operations and media sub-resources. The media sub-resource pattern is identical to messages.

Access via client.compat.faxes on a RestClient instance.

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com",
7 });
8 
9 const faxes = await client.compat.faxes.list();

Methods

Fax CRUD

list

List faxes in the account.

create

Send a new fax.

get

Retrieve a single fax by SID.

update

Update a fax resource.

delete

Delete a fax record.

Media

listMedia

List media items attached to a fax.

getMedia

Retrieve a specific media item from a fax.

deleteMedia

Delete a media item from a fax.

1	import { RestClient } from "@signalwire/sdk";
2
3	const client = new RestClient({
4	project: "your-project-id",
5	token: "your-api-token",
6	host: "your-space.signalwire.com",
7	});
8
9	const faxes = await client.compat.faxes.list();