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 comments = await client.comments.list();

console.log(comments.data);

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "body": "Hi there, ....",
      "commenter": "[email protected]",
      "commenter_type": "user",
      "comment_record_type": "sub_number_order",
      "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
      "read_at": "2018-01-01T00:00:00.000000Z",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

comments

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(comments.data);

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "body": "Hi there, ....",
      "commenter": "[email protected]",
      "commenter_type": "user",
      "comment_record_type": "sub_number_order",
      "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
      "read_at": "2018-01-01T00:00:00.000000Z",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[comment_record_type], filter[comment_record_id]

Show child attributes

filter[comment_record_type]

enum<string>

Record type that the comment relates to

Available options:

sub_number_order,

requirement_group

Example:

"sub_number_order"

filter[comment_record_id]

string

ID of the record the comments relate to

Example:

"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"

Response

An array of Comment Responses

data

object[]

Show child attributes

data.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.body

string

Example:

"Hi there, ...."

data.commenter

string

Example:

"[email protected]"

data.commenter_type

enum<string>

Available options:

admin,

user

Example:

"user"

data.comment_record_type

enum<string>

Available options:

sub_number_order,

requirement_group

Example:

"sub_number_order"

data.comment_record_id

string<uuid>

Example:

"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"

data.read_at

string<date-time>

An ISO 8901 datetime string for when the comment was read.

Example:

"2018-01-01T00:00:00.000000Z"

data.created_at

string<date-time>

An ISO 8901 datetime string denoting when the comment was created.

Example:

"2018-01-01T00:00:00.000000Z"

data.updated_at

string<date-time>

An ISO 8901 datetime string for when the comment was updated.

Example:

"2018-01-01T00:00:00.000000Z"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Retrieve all comments

Authorizations

Query Parameters

Response