List all log messages

GET 
/external_connections/log_messages

Retrieve a list of log messages for all external connections associated with your account.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 250

The size of the page

filter[external_connection_id] string

The external connection ID to filter by or "null" to filter for logs without an external connection ID

filter[telephone_number][contains] string

The partial phone number to filter log messages for. Requires 3-15 digits.

filter[telephone_number][eq] string

The phone number to filter log messages for or "null" to filter for logs without a phone number

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

log_messages

object[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

meta

object

telephone_number string

The telephone number the log message is associated with, if any.

external_connection_id int64

The external connection the log message is associated with, if any.

ticket_id uuid

The ticket ID for an operation that generated the log message, if any.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "log_messages": [
    {
      "code": "10015",
      "title": "Invalid attribute",
      "detail": "The value provided for the attribute is not valid. Check the value used and try again.",
      "source": {
        "pointer": "/attribute"
      },
      "meta": {
        "telephone_number": "+12345678",
        "external_connection_id": "1293384261075731499",
        "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

401: Unauthorized

422: Bad request

Loading...