For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
        • Faxes
          • create
          • delete
          • deleteMedia
          • get
          • getMedia
          • list
          • listMedia
          • update
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientCompatFaxes

get

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

getMedia

Next
Built with

Retrieve a single fax by SID.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
SidstringRequiredformat: "uuid"
The Fax ID that uniquely identifies the Fax.

Response

account_sidstringRequired
The unique identifier for the account this fax is associated with.
api_versionstringRequired
The version of the SignalWire API.
date_createdstringRequired
The date and time, in ISO 8601 format, the fax was created.
date_updatedstringRequired
The date and time, in ISO 8601 format, the fax was updated.
directionenumRequired
The direction of the fax.
Allowed values:
fromstringRequired
The phone number, in E.164 format, the fax was sent from.
media_urlstring or nullRequired
The URL hosting the received media, or null if not available.
media_sidstringRequired
The unique identifier for the media instance associated with the fax instance.
num_pagesstring or nullRequired
The number of pages in the fax document, or null if not yet determined.
pricestring or nullRequired
The cost of the fax, or null if not yet calculated.
price_unitstringRequired
The currency, in ISO 4217 format, of the price.
qualityenumRequired
The quality of the fax.
Allowed values:
sidstringRequired
The unique identifier of the fax.
statusenumRequired
The status of the fax.
tostringRequired
The phone number, in E.164 format, the fax was sent to.
durationintegerRequired
The time, in seconds, it took to deliver a fax.
linksobjectRequired
The URL links for resources associated with the fax.
urlstringRequired
The URL of this resource.
error_codestring or nullRequired
Error code for this resource, or null if no error.
error_messagestring or nullRequired
The description of this error, or null if no error.

Response Example

Response
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
3  "api_version": "v1",
4  "date_created": "2018-11-26T20:00:00Z",
5  "date_updated": "2018-11-27T20:00:00Z",
6  "direction": "inbound",
7  "from": "+13103383454",
8  "media_url": "https://example.com/fax.pdf",
9  "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
10  "num_pages": "3",
11  "price": "-0.005",
12  "price_unit": "USD",
13  "quality": "standard",
14  "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
15  "status": "queued",
16  "to": "+13104456789",
17  "duration": 5000,
18  "links": {
19    "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
20  },
21  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
22  "error_code": null,
23  "error_message": null
24}

Example

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