v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Fax Logs

Get fax log

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.

get/api/fax/logs/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the log

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

fromstring nullable required

The origin phone number in E.164 format.

tostring nullable required

The destination phone number in E.164 format.

The status of this fax call.

direction'inbound' | 'outbound-api' | 'outbound-dial' nullable required

The direction of this fax call.

source'laml' required

Source of this log entry.

type'laml_call' required

Type of this log entry.

urlstring uri required

URL for the associated fax resource with this log entry.

remote_stationstring nullable required

Represents a customer hosted Fax server.

chargenumber double required

The amount charged for this fax request.

number_of_pagesinteger nullable required

The number of pages the fax document contained.

quality'fine' | 'standard' | 'superfine' nullable required

The quality that was set when the fax document was sent.

created_atstring date-time required

Date and time when the fax was created.

error_codestring nullable required

Error code for this resource (if available).

error_messagestring nullable required

The description of this error (if available).

Example response

{
  "from": "+12065551212",
  "to": "+12065553434",
  "status": "completed",
  "direction": "inbound",
  "source": "laml",
  "type": "laml_call",
  "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b7182dc2-00f3-40e4-a5ce-20f164b329df/Faxes/c9a1d3e4-56f7-89ab-cdef-0123456789ab",
  "charge": 0.01,
  "number_of_pages": 2,
  "quality": "fine",
  "charge_details": [],
  "created_at": "2024-05-06T12:20:00Z",
  "error_code": "34004",
  "error_message": "The call dropped prematurely"
}