Check out our upcoming events and meetups! View events →
Returns the portout requests according to filters
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 portoutDetails of client.portouts.list()) {
console.log(portoutDetails.id);
}{
"data": [
{
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"record_type": "portout",
"phone_numbers": [
"+35312345678"
],
"authorized_name": "McPortersen",
"carrier_name": "test",
"current_carrier": "telnyx",
"end_user_name": "McPortersen",
"city": "Chicago",
"state": "IL",
"zip": "00000",
"lsr": [
"https://example.com/files/lsr.pdf"
],
"pon": "00000000",
"reason": null,
"rejection_code": 1002,
"service_address": "000 Example Street",
"foc_date": "2018-02-02T22:25:27.521Z",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"support_key": "PO_764725",
"status": "rejected",
"already_ported": false,
"user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a",
"vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661",
"created_at": "2018-02-02T22:25:27.521Z",
"inserted_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"host_messaging": false
}
],
"meta": {
"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}Documentation Index
Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Show child attributes
Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code], filter[country_code_in], filter[foc_date], filter[inserted_at], filter[phone_number], filter[pon], filter[ported_out_at], filter[spid], filter[status], filter[status_in], filter[support_key]
Show child attributes
Was this page helpful?
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 portoutDetails of client.portouts.list()) {
console.log(portoutDetails.id);
}{
"data": [
{
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"record_type": "portout",
"phone_numbers": [
"+35312345678"
],
"authorized_name": "McPortersen",
"carrier_name": "test",
"current_carrier": "telnyx",
"end_user_name": "McPortersen",
"city": "Chicago",
"state": "IL",
"zip": "00000",
"lsr": [
"https://example.com/files/lsr.pdf"
],
"pon": "00000000",
"reason": null,
"rejection_code": 1002,
"service_address": "000 Example Street",
"foc_date": "2018-02-02T22:25:27.521Z",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"support_key": "PO_764725",
"status": "rejected",
"already_ported": false,
"user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a",
"vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661",
"created_at": "2018-02-02T22:25:27.521Z",
"inserted_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"host_messaging": false
}
],
"meta": {
"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}