Skip to main content

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​

OK

Schema

    id uuid

    A unique identifier for the log

    from string

    The origin phone number in E.164 format.

    Example: +12065551212
    to string

    The destination phone number in E.164 format.

    Example: +12065553434
    status string

    The status of this fax call.

    Example: completed
    direction string

    The direction of this fax call.

    Example: outbound
    source string

    Source of this log entry.

    Example: laml
    type string

    Type of this log entry.

    Example: laml_call
    url string

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

    remote_station string
    charge number
    Example: 0.01
    number_of_pages integer
    Example: 2
    quality string
    Example: fine

    charge_details

    object[]

    Details on charges associated with this log.

  • Array [

    • description string

    Description for this charge.

    charge number

    Charged amount.

  • ]

    • created_at date-time
    updated_at date-time
    error_code string

    Error code for this resource (if available).

    Example: 34004
    error_message string

    The description of this error (if available).

    Example: The call dropped prematurely