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 response = await client.documents.uploadJson({ document: {} });

console.log(response.data);

{
  "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"
  }
}

POST

documents

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.documents.uploadJson({ document: {} });

console.log(response.data);

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

url

string

If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.

Example:

"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"

file

string<byte>

Alternatively, instead of the URL you can provide the Base64 encoded contents of the file you are uploading.

Example:

"ZXhhbXBsZSBvZiBlbmNvZGVkIGNvbnRlbnQ="

filename

string

The filename of the document.

Example:

"test-document.pdf"

customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

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"

List all documents Retrieve a document

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Upload a document

Authorizations

Body

Response