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 loaConfiguration = await client.porting.loaConfigurations.create({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: '[email protected]', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(loaConfiguration.data);

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "company_name": "Telnyx",
    "organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "name": "My LOA Configuration",
    "logo": {
      "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "content_type": "image/png"
    },
    "address": {
      "street_address": "600 Congress Avenue",
      "extended_address": "14th Floor",
      "city": "Austin",
      "state": "TX",
      "zip_code": "78701",
      "country_code": "US"
    },
    "contact": {
      "email": "[email protected]",
      "phone_number": "+12003270001"
    },
    "record_type": "porting_loa_configuration",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}

POST

porting

loa_configurations

JavaScript

import Telnyx from 'telnyx';

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

const loaConfiguration = await client.porting.loaConfigurations.create({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: '[email protected]', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(loaConfiguration.data);

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "company_name": "Telnyx",
    "organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "name": "My LOA Configuration",
    "logo": {
      "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "content_type": "image/png"
    },
    "address": {
      "street_address": "600 Congress Avenue",
      "extended_address": "14th Floor",
      "city": "Austin",
      "state": "TX",
      "zip_code": "78701",
      "country_code": "US"
    },
    "contact": {
      "email": "[email protected]",
      "phone_number": "+12003270001"
    },
    "record_type": "porting_loa_configuration",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The parameters for creating a new LOA configuration.

name

string

required

The name of the LOA configuration

Example:

"My LOA Configuration"

logo

object

required

The logo of the LOA configuration

Show child attributes

logo.document_id

string<uuid>

required

The document identification

company_name

string

required

The name of the company

Example:

"Telnyx"

address

object

required

The address of the company.

Show child attributes

address.street_address

string

required

The street address of the company

Example:

"600 Congress Avenue"

address.city

string

required

The locality of the company

Example:

"Austin"

address.state

string

required

The administrative area of the company

Example:

"TX"

address.zip_code

string

required

The postal code of the company

Example:

"78701"

address.country_code

string

required

The country code of the company

Example:

"US"

address.extended_address

string

The extended address of the company

Example:

"14th Floor"

contact

object

required

The contact information of the company.

Show child attributes

contact.email

string

required

The email address of the contact

Example:

"[email protected]"

contact.phone_number

string

required

The phone number of the contact

Example:

"+12003270001"

Response

Successful response

data

object

Show child attributes

data.id

string<uuid>

Uniquely identifies the LOA configuration.

Example:

"eef3340b-8903-4466-b445-89b697315a3a"

data.company_name

string

The name of the company

Example:

"Telnyx"

data.organization_id

string

The organization that owns the LOA configuration

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.name

string

The name of the LOA configuration

Example:

"My LOA Configuration"

data.logo

object

The logo to be used in the LOA.

Show child attributes

data.logo.document_id

string<uuid>

Identifies the document that contains the logo.

Example:

"f1486bae-f067-460c-ad43-73a92848f902"

data.logo.content_type

enum<string>

The content type of the logo.

Available options:

image/png

Example:

"image/png"

data.address

object

The address of the company.

Show child attributes

data.address.street_address

string

The street address of the company

Example:

"600 Congress Avenue"

data.address.extended_address

string

The extended address of the company

Example:

"14th Floor"

data.address.city

string

The locality of the company

Example:

"Austin"

data.address.state

string

The administrative area of the company

Example:

"TX"

data.address.zip_code

string

The postal code of the company

Example:

"78701"

data.address.country_code

string

The country code of the company

Example:

"US"

data.contact

object

The contact information of the company.

Show child attributes

data.contact.email

string

The email address of the contact

Example:

"[email protected]"

data.contact.phone_number

string

The phone number of the contact

Example:

"+12003270001"

data.record_type

string

Identifies the type of the resource.

Example:

"porting_loa_configuration"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527000Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2021-03-19T10:07:15.527000Z"

List LOA configurations Retrieve a LOA configuration

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Create a LOA configuration

Authorizations

Body

Response