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
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
      • GETGet fax log
      • GETList fax logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
LogsFax Logs

Get fax log

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/fax/logs/:id
GET
/api/fax/logs/:id
$curl https://{your_space_name}.signalwire.com/api/fax/logs/id \
>     -u "<project_id>:<api_token>"
1{
2  "id": "b7182dc2-00f3-40e4-a5ce-20f164b329df",
3  "from": "+12065551212",
4  "to": "+12065553434",
5  "status": "completed",
6  "direction": "inbound",
7  "source": "laml",
8  "type": "laml_call",
9  "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b7182dc2-00f3-40e4-a5ce-20f164b329df/Faxes/c9a1d3e4-56f7-89ab-cdef-0123456789ab",
10  "remote_station": null,
11  "charge": 0.01,
12  "number_of_pages": 2,
13  "quality": "fine",
14  "charge_details": [],
15  "created_at": "2024-05-06T12:20:00Z",
16  "error_code": "34004",
17  "error_message": "The call dropped prematurely"
18}

Find a log by ID.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.

Learn more about API scopes.

Was this page helpful?
Previous

List fax logs

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the log

Response

The request has succeeded.
idstringformat: "uuid"
A unique identifier for the log
fromstring or null
The origin phone number in E.164 format.
tostring or null
The destination phone number in E.164 format.
statusenum
The status of this fax call.
directionenum or null
The direction of this fax call.
Allowed values:
sourceenum
Source of this log entry.
Allowed values:
typeenum
Type of this log entry.
Allowed values:
urlstringformat: "uri"
URL for the associated fax resource with this log entry.
remote_stationstring or null
Represents a customer hosted Fax server.
chargedouble
The amount charged for this fax request.
number_of_pagesinteger or null
The number of pages the fax document contained.
qualityenum or null
The quality that was set when the fax document was sent.
Allowed values:
charge_detailslist of objects
Details on charges associated with this log.
created_atdatetime
Date and time when the fax was created.
error_codestring or null

Error code for this resource (if available).

error_messagestring or null

The description of this error (if available).

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)