0

List all port-out events

by
Published Apr 8, 2025

Returns a list of all port-out events.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * List all port-out events
7
 * Returns a list of all port-out events.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	page_number_: string | undefined,
12
	page_size_: string | undefined,
13
	filter_event_type_:
14
		| 'portout.status_changed'
15
		| 'portout.new_comment'
16
		| 'portout.foc_date_changed'
17
		| undefined,
18
	filter_portout_id_: string | undefined,
19
	filter_created_at__gte_: string | undefined,
20
	filter_created_at__lte_: string | undefined
21
) {
22
	const url = new URL(`https://api.telnyx.com/v2/portouts/events`)
23
	for (const [k, v] of [
24
		['page[number]', page_number_],
25
		['page[size]', page_size_],
26
		['filter[event_type]', filter_event_type_],
27
		['filter[portout_id]', filter_portout_id_],
28
		['filter[created_at][gte]', filter_created_at__gte_],
29
		['filter[created_at][lte]', filter_created_at__lte_]
30
	]) {
31
		if (v !== undefined && v !== '' && k !== undefined) {
32
			url.searchParams.append(k, v)
33
		}
34
	}
35
	const response = await fetch(url, {
36
		method: 'GET',
37
		headers: {
38
			Authorization: 'Bearer ' + auth.apiKey
39
		},
40
		body: undefined
41
	})
42
	if (!response.ok) {
43
		const text = await response.text()
44
		throw new Error(`${response.status} ${text}`)
45
	}
46
	return await response.json()
47
}
48