get | SignalWire

Retrieve a specific fax log entry.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the log

Response

idstringRequiredformat: "uuid"

A unique identifier for the log

fromstring or nullRequired

The origin phone number in E.164 format.

tostring or nullRequired

The destination phone number in E.164 format.

statusenumRequired

The status of this fax call.

directionenum or nullRequired

The direction of this fax call.

Allowed values:

sourceenumRequired

Source of this log entry.

Allowed values:

typeenumRequired

Type of this log entry.

Allowed values:

urlstringRequiredformat: "uri"

URL for the associated fax resource with this log entry.

remote_stationstring or nullRequired

Represents a customer hosted Fax server.

chargedoubleRequired

The amount charged for this fax request.

number_of_pagesinteger or nullRequired

The number of pages the fax document contained.

qualityenum or nullRequired

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

Allowed values:

charge_detailslist of objectsRequired

Details on charges associated with this log.

created_atdatetimeRequired

Date and time when the fax was created.

error_codestring or nullRequired

Error code for this resource (if available).

error_messagestring or nullRequired

The description of this error (if available).

Response Example

Response

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   "charge": 0.01,
11   "number_of_pages": 2,
12   "quality": "fine",
13   "charge_details": [],
14   "created_at": "2024-05-06T12:20:00Z",
15   "error_code": "34004",
16   "error_message": "The call dropped prematurely"
17 }

Example

1 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 fax = client.logs.fax.get("fax-log-id")
10 print(fax.get("from"), "->", fax.get("to"))