Find a Log by ID

GET 
/logs/:id

Find a log by ID.

Permissions

The API token must include the following scopes: Fax.

Request

Path Parameters

id uuidrequired

Unique ID of the log

Responses

200

OK

application/json

Schema

Schema

iduuid

A unique identifier for the log

fromstring
The origin phone number in E.164 format.
Example: +12065551212
tostring
The destination phone number in E.164 format.
Example: +12065553434
statusstring
The status of this fax call.
Example: completed
directionstring
The direction of this fax call.
Example: outbound
sourcestring
Source of this log entry.
Example: laml
typestring
Type of this log entry.
Example: laml_call
urlstring

URL for the resource associated with this log entry (if available)

remote_stationstring
chargenumber
Example: 0.01
number_of_pagesinteger
Example: 2
qualitystring
Example: fine

charge_details

object[]

Details on charges associated with this log.

Array [

descriptionstring

Description for this charge.

chargenumber

Charged amount.

]

created_atdate-time
updated_atdate-time
error_codestring
Error code for this resource (if available).
Example: 34004
error_messagestring
The description of this error (if available).
Example: The call dropped prematurely

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "from": "+12065551212",
  "to": "+12065553434",
  "status": "completed",
  "direction": "outbound",
  "source": "laml",
  "type": "laml_call",
  "url": "string",
  "remote_station": "string",
  "charge": "0.01",
  "number_of_pages": "2",
  "quality": "fine",
  "charge_details": [],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "error_code": "34004",
  "error_message": "The call dropped prematurely"
}