Telnyx

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const docServiceDocument of client.documents.list()) {
  console.log(docServiceDocument.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "document",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "content_type": "application/pdf",
      "size": {
        "unit": "bytes",
        "amount": 123456
      },
      "status": "pending",
      "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
      "filename": "test-document.pdf",
      "customer_reference": "MY REF 001",
      "av_scan_status": "scanned"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

documents

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const docServiceDocument of client.documents.list()) {
  console.log(docServiceDocument.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "document",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "content_type": "application/pdf",
      "size": {
        "unit": "bytes",
        "amount": 123456
      },
      "status": "pending",
      "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
      "filename": "test-document.pdf",
      "customer_reference": "MY REF 001",
      "av_scan_status": "scanned"
    }
  ],
  "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 for documents (deepObject style). Originally: filter[filename][contains], filter[customer_reference][eq], filter[customer_reference][in][], filter[created_at][gt], filter[created_at][lt]

Show child attributes

filter[filename]

object

Show child attributes

filter[filename][contains]

string

Filter by string matching part of filename.

Example:

"invoice"

filter[customer_reference]

object

Show child attributes

filter[customer_reference][eq]

string

Filter documents by a customer reference.

Example:

"MY REF 001"

filter[customer_reference][in]

string[]

Filter documents by a list of customer references.

Example:

["MY REF 001", "MY REF 002"]

filter[created_at]

object

Show child attributes

filter[created_at][gt]

string<date-time>

Filter by created at greater than provided value.

Example:

"2021-04-09T22:25:27.521Z"

filter[created_at][lt]

string<date-time>

Filter by created at less than provided value.

Example:

"2021-04-09T22:25:27.521Z"

Example:

{
  "filename": { "contains": "invoice" },
  "customer_reference": { "in": ["REF001", "REF002"] },
  "created_at": { "gt": "2021-01-01T00:00:00Z" }
}

sort

enum<string>[]

Consolidated sort parameter for documents (deepObject style). Originally: sort[] Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

Available options:

filename,

created_at,

updated_at,

-filename,

-created_at,

-updated_at

Example:

["filename"]

page

object

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

Show child attributes

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

Response

Successful response

data

object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Identifies the type of the resource. Identifies the type of the resource.

Example:

"document"

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

data.content_type

string

The document's content_type.

Example:

"application/pdf"

data.size

object

Indicates the document's filesize

Show child attributes

data.size.unit

string

Identifies the unit

Example:

"bytes"

data.size.amount

integer

The number of bytes

Example:

123456

data.status

enum<string>

Indicates the current document reviewing status

Available options:

pending,

verified,

denied

Example:

"pending"

data.sha256

string

The document's SHA256 hash provided for optional verification purposes.

Example:

"08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c"

data.filename

string

The filename of the document.

Example:

"test-document.pdf"

data.customer_reference

string

Optional reference string for customer tracking.

Example:

"MY REF 001"

data.av_scan_status

enum<string>

The antivirus scan status of the document.

Available options:

scanned,

infected,

pending_scan,

not_scanned

Example:

"scanned"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all documents

Authorizations

Query Parameters

Response