List all port-out events
Returns a list of all port-out events.
GET
/
portouts
/
events
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 eventListResponse of client.portouts.events.list()) {
console.log(eventListResponse);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.portouts.events.list()
page = page.data[0]
print(page)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"),
)
page, err := client.Portouts.Events.List(context.TODO(), telnyx.PortoutEventListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portouts.events.EventListPage;
import com.telnyx.sdk.models.portouts.events.EventListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
EventListPage page = client.portouts().events().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.portouts.events.list
puts(page)<?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 {
$page = $client->portouts->events->list(
filter: [
'createdAt' => [
'gte' => new \DateTimeImmutable('2021-01-01T00:00:00Z'),
'lte' => new \DateTimeImmutable('2021-01-01T00:00:00Z'),
],
'eventType' => 'portout.status_changed',
'portoutID' => '34dc46a9-53ed-4e01-9454-26227ea13326',
],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx portouts:events list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/portouts/events \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"event_type": "portout.status_changed",
"portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
"available_notification_methods": [],
"payload_status": "created",
"payload": {
"id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
"status": "authorized",
"phone_numbers": [
"+35312345678"
],
"carrier_name": "Testing Carrier",
"spid": "987H",
"user_id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
"subscriber_name": "John Doe",
"rejection_reason": null,
"attempted_pin": "1234"
},
"record_type": "portout_event",
"created_at": "2021-03-19T10:07:15.527000Z",
"updated_at": "2021-03-19T10:07:15.527000Z"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Show child attributes
Show child attributes
Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id], filter[created_at]
Show child attributes
Show child attributes
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
});
// Automatically fetches more pages as needed.
for await (const eventListResponse of client.portouts.events.list()) {
console.log(eventListResponse);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.portouts.events.list()
page = page.data[0]
print(page)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"),
)
page, err := client.Portouts.Events.List(context.TODO(), telnyx.PortoutEventListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portouts.events.EventListPage;
import com.telnyx.sdk.models.portouts.events.EventListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
EventListPage page = client.portouts().events().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.portouts.events.list
puts(page)<?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 {
$page = $client->portouts->events->list(
filter: [
'createdAt' => [
'gte' => new \DateTimeImmutable('2021-01-01T00:00:00Z'),
'lte' => new \DateTimeImmutable('2021-01-01T00:00:00Z'),
],
'eventType' => 'portout.status_changed',
'portoutID' => '34dc46a9-53ed-4e01-9454-26227ea13326',
],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx portouts:events list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/portouts/events \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"event_type": "portout.status_changed",
"portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
"available_notification_methods": [],
"payload_status": "created",
"payload": {
"id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
"status": "authorized",
"phone_numbers": [
"+35312345678"
],
"carrier_name": "Testing Carrier",
"spid": "987H",
"user_id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
"subscriber_name": "John Doe",
"rejection_reason": null,
"attempted_pin": "1234"
},
"record_type": "portout_event",
"created_at": "2021-03-19T10:07:15.527000Z",
"updated_at": "2021-03-19T10:07:15.527000Z"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}