0

List number reservations

by
Published Apr 8, 2025

Gets a paginated list of phone number reservations.

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 number reservations
7
 * Gets a paginated list of phone number reservations.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	filter_status_: string | undefined,
12
	filter_created_at__gt_: string | undefined,
13
	filter_created_at__lt_: string | undefined,
14
	filter_phone_numbers_phone_number_: string | undefined,
15
	filter_customer_reference_: string | undefined,
16
	page_number_: string | undefined,
17
	page_size_: string | undefined
18
) {
19
	const url = new URL(`https://api.telnyx.com/v2/number_reservations`)
20
	for (const [k, v] of [
21
		['filter[status]', filter_status_],
22
		['filter[created_at][gt]', filter_created_at__gt_],
23
		['filter[created_at][lt]', filter_created_at__lt_],
24
		['filter[phone_numbers.phone_number]', filter_phone_numbers_phone_number_],
25
		['filter[customer_reference]', filter_customer_reference_],
26
		['page[number]', page_number_],
27
		['page[size]', page_size_]
28
	]) {
29
		if (v !== undefined && v !== '' && k !== undefined) {
30
			url.searchParams.append(k, v)
31
		}
32
	}
33
	const response = await fetch(url, {
34
		method: 'GET',
35
		headers: {
36
			Authorization: 'Bearer ' + auth.apiKey
37
		},
38
		body: undefined
39
	})
40
	if (!response.ok) {
41
		const text = await response.text()
42
		throw new Error(`${response.status} ${text}`)
43
	}
44
	return await response.json()
45
}
46