Preview the LOA configuration parameters
Preview the LOA template that would be generated without need to create LOA configuration.
POST
/
porting
/
loa_configurations
/
preview
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.porting.loaConfigurations.preview({
address: {
city: 'Austin',
country_code: 'US',
state: 'TX',
street_address: '600 Congress Avenue',
zip_code: '78701',
},
company_name: 'Telnyx',
contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
name: 'My LOA Configuration',
});
console.log(response);
const content = await response.blob();
console.log(content);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.porting.loa_configurations.preview(
address={
"city": "Austin",
"country_code": "US",
"state": "TX",
"street_address": "600 Congress Avenue",
"zip_code": "78701",
},
company_name="Telnyx",
contact={
"email": "testing@telnyx.com",
"phone_number": "+12003270001",
},
logo={
"document_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
name="My LOA Configuration",
)
print(response)
content = response.read()
print(content)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Porting.LoaConfigurations.Preview(context.TODO(), telnyx.PortingLoaConfigurationPreviewParams{
Address: telnyx.PortingLoaConfigurationPreviewParamsAddress{
City: "Austin",
CountryCode: "US",
State: "TX",
StreetAddress: "600 Congress Avenue",
ZipCode: "78701",
},
CompanyName: "Telnyx",
Contact: telnyx.PortingLoaConfigurationPreviewParamsContact{
Email: "testing@telnyx.com",
PhoneNumber: "+12003270001",
},
Logo: telnyx.PortingLoaConfigurationPreviewParamsLogo{
DocumentID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
},
Name: "My LOA Configuration",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationPreviewParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
LoaConfigurationPreviewParams params = LoaConfigurationPreviewParams.builder()
.address(LoaConfigurationPreviewParams.Address.builder()
.city("Austin")
.countryCode("US")
.state("TX")
.streetAddress("600 Congress Avenue")
.zipCode("78701")
.build())
.companyName("Telnyx")
.contact(LoaConfigurationPreviewParams.Contact.builder()
.email("testing@telnyx.com")
.phoneNumber("+12003270001")
.build())
.logo(LoaConfigurationPreviewParams.Logo.builder()
.documentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.build())
.name("My LOA Configuration")
.build();
HttpResponse response = client.porting().loaConfigurations().preview(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.porting.loa_configurations.preview(
address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
company_name: "Telnyx",
contact: {email: "testing@telnyx.com", phone_number: "+12003270001"},
logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
name: "My LOA Configuration"
)
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->porting->loaConfigurations->preview(
address: [
'city' => 'Austin',
'countryCode' => 'US',
'state' => 'TX',
'streetAddress' => '600 Congress Avenue',
'zipCode' => '78701',
'extendedAddress' => '14th Floor',
],
companyName: 'Telnyx',
contact: ['email' => 'testing@telnyx.com', 'phoneNumber' => '+12003270001'],
logo: ['documentID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
name: 'My LOA Configuration',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx porting:loa-configurations preview \
--api-key 'My API Key' \
--address "{city: Austin, country_code: US, state: TX, street_address: 600 Congress Avenue, zip_code: '78701'}" \
--company-name Telnyx \
--contact "{email: testing@telnyx.com, phone_number: '+12003270001'}" \
--logo '{document_id: 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e}' \
--name 'My LOA Configuration'curl --request POST \
--url https://api.telnyx.com/v2/porting/loa_configurations/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My LOA Configuration",
"logo": {
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"company_name": "Telnyx",
"address": {
"street_address": "600 Congress Avenue",
"city": "Austin",
"state": "TX",
"zip_code": "78701",
"country_code": "US",
"extended_address": "14th Floor"
},
"contact": {
"email": "testing@telnyx.com",
"phone_number": "+12003270001"
}
}
'"%PDF-1.4..."Authorizations
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.
The name of the LOA configuration
Example:
"My LOA Configuration"
The logo of the LOA configuration
Show child attributes
Show child attributes
The name of the company
Example:
"Telnyx"
The address of the company.
Show child attributes
Show child attributes
The contact information of the company.
Show child attributes
Show child attributes
Response
Successful response
The response is of type file.
Was this page helpful?
⌘I
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.porting.loaConfigurations.preview({
address: {
city: 'Austin',
country_code: 'US',
state: 'TX',
street_address: '600 Congress Avenue',
zip_code: '78701',
},
company_name: 'Telnyx',
contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
name: 'My LOA Configuration',
});
console.log(response);
const content = await response.blob();
console.log(content);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.porting.loa_configurations.preview(
address={
"city": "Austin",
"country_code": "US",
"state": "TX",
"street_address": "600 Congress Avenue",
"zip_code": "78701",
},
company_name="Telnyx",
contact={
"email": "testing@telnyx.com",
"phone_number": "+12003270001",
},
logo={
"document_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
name="My LOA Configuration",
)
print(response)
content = response.read()
print(content)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Porting.LoaConfigurations.Preview(context.TODO(), telnyx.PortingLoaConfigurationPreviewParams{
Address: telnyx.PortingLoaConfigurationPreviewParamsAddress{
City: "Austin",
CountryCode: "US",
State: "TX",
StreetAddress: "600 Congress Avenue",
ZipCode: "78701",
},
CompanyName: "Telnyx",
Contact: telnyx.PortingLoaConfigurationPreviewParamsContact{
Email: "testing@telnyx.com",
PhoneNumber: "+12003270001",
},
Logo: telnyx.PortingLoaConfigurationPreviewParamsLogo{
DocumentID: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
},
Name: "My LOA Configuration",
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationPreviewParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
LoaConfigurationPreviewParams params = LoaConfigurationPreviewParams.builder()
.address(LoaConfigurationPreviewParams.Address.builder()
.city("Austin")
.countryCode("US")
.state("TX")
.streetAddress("600 Congress Avenue")
.zipCode("78701")
.build())
.companyName("Telnyx")
.contact(LoaConfigurationPreviewParams.Contact.builder()
.email("testing@telnyx.com")
.phoneNumber("+12003270001")
.build())
.logo(LoaConfigurationPreviewParams.Logo.builder()
.documentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.build())
.name("My LOA Configuration")
.build();
HttpResponse response = client.porting().loaConfigurations().preview(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.porting.loa_configurations.preview(
address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
company_name: "Telnyx",
contact: {email: "testing@telnyx.com", phone_number: "+12003270001"},
logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
name: "My LOA Configuration"
)
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->porting->loaConfigurations->preview(
address: [
'city' => 'Austin',
'countryCode' => 'US',
'state' => 'TX',
'streetAddress' => '600 Congress Avenue',
'zipCode' => '78701',
'extendedAddress' => '14th Floor',
],
companyName: 'Telnyx',
contact: ['email' => 'testing@telnyx.com', 'phoneNumber' => '+12003270001'],
logo: ['documentID' => '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
name: 'My LOA Configuration',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx porting:loa-configurations preview \
--api-key 'My API Key' \
--address "{city: Austin, country_code: US, state: TX, street_address: 600 Congress Avenue, zip_code: '78701'}" \
--company-name Telnyx \
--contact "{email: testing@telnyx.com, phone_number: '+12003270001'}" \
--logo '{document_id: 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e}' \
--name 'My LOA Configuration'curl --request POST \
--url https://api.telnyx.com/v2/porting/loa_configurations/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My LOA Configuration",
"logo": {
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"company_name": "Telnyx",
"address": {
"street_address": "600 Congress Avenue",
"city": "Austin",
"state": "TX",
"zip_code": "78701",
"country_code": "US",
"extended_address": "14th Floor"
},
"contact": {
"email": "testing@telnyx.com",
"phone_number": "+12003270001"
}
}
'"%PDF-1.4..."