Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const auditEvents = await client.auditEvents.list();

console.log(auditEvents.data);

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440001",
      "record_type": "audit_event",
      "resource_id": "550e8400-e29b-41d4-a716-446655440002",
      "alternate_resource_id": "+14155551234",
      "change_made_by": "organization_member",
      "changes": [
        {
          "field": "field.name",
          "to": "old value",
          "from": "new value"
        }
      ],
      "organization_id": "550e8400-e29b-41d4-a716-446655440003",
      "change_type": "update",
      "created_at": "2023-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 50,
    "page_number": 1,
    "page_size": 10
  }
}

GET

audit_events

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const auditEvents = await client.auditEvents.list();

console.log(auditEvents.data);

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440001",
      "record_type": "audit_event",
      "resource_id": "550e8400-e29b-41d4-a716-446655440002",
      "alternate_resource_id": "+14155551234",
      "change_made_by": "organization_member",
      "changes": [
        {
          "field": "field.name",
          "to": "old value",
          "from": "new value"
        }
      ],
      "organization_id": "550e8400-e29b-41d4-a716-446655440003",
      "change_type": "update",
      "created_at": "2023-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 50,
    "page_number": 1,
    "page_size": 10
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

page[number]

integer

Page number to load.

Example:

1

page[size]

integer

Number of items per page.

Example:

10

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[created_before], filter[created_after]

Show child attributes

filter[created_before]

string<date-time>

Filter for audit events created before a specific date.

Example:

"2021-01-01T00:00:00Z"

filter[created_after]

string<date-time>

Filter for audit events created after a specific date.

Example:

"2021-01-01T00:00:00Z"

sort

enum<string>

Set the order of the results by the creation date.

Available options:

asc,

desc

Example:

"desc"

Response

A list of audit log entries.

data

Audit Log Entry · object[]

Show child attributes

data.id

string<uuid>

Unique identifier for the audit log entry.

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.user_id

string<uuid>

Unique identifier for the user who made the change.

Example:

"550e8400-e29b-41d4-a716-446655440001"

data.record_type

string

The type of the resource being audited.

Example:

"audit_event"

data.resource_id

string

Unique identifier for the resource that was changed.

Example:

"550e8400-e29b-41d4-a716-446655440002"

data.alternate_resource_id

string | null

An alternate identifier for a resource which may be considered unique enough to identify the resource but is not the primary identifier for the resource. For example, this field could be used to store the phone number value for a phone number when the primary database identifier is a separate distinct value.

Example:

"+14155551234"

data.change_made_by

enum<string>

Indicates if the change was made by Telnyx on your behalf, the organization owner, a member of your organization, or in the case of managed accounts, the account manager.

Available options:

telnyx,

account_manager,

account_owner,

organization_member

Example:

"organization_member"

data.changes

Audit Event Changes · object[] | null

Details of the changes made to the resource.

Show child attributes

data.changes.field

string

The name of the field that was changed. May use the dot notation to indicate nested fields.

Example:

"nested.field.name"

data.changes.to

The new value of the field. Can be any JSON type.

Example:

12345

data.changes.from

The previous value of the field. Can be any JSON type.

Example:

54321

Example:

[
  {
    "field": "field.name",
    "to": "old value",
    "from": "new value"
  }
]

data.organization_id

string<uuid>

Unique identifier for the organization that owns the resource.

Example:

"550e8400-e29b-41d4-a716-446655440003"

data.change_type

string

The type of change that occurred.

Example:

"update"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the change occurred.

Example:

"2023-01-01T00:00:00Z"

AI

Real-Time Communications

Numbers & Identity

Connectivity & Networking

Storage & Data

Account & Billing

SETI

OAuth

List Audit Logs

Authorizations

Query Parameters

Response