0

Lookup phone number data

by
Published Apr 8, 2025

Returns information about the provided phone number.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Lookup phone number data
7
 * Returns information about the provided phone number.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	phone_number: string,
12
	type: 'carrier' | 'caller-name' | undefined
13
) {
14
	const url = new URL(`https://api.telnyx.com/v2/number_lookup/${phone_number}`)
15
	for (const [k, v] of [['type', type]]) {
16
		if (v !== undefined && v !== '' && k !== undefined) {
17
			url.searchParams.append(k, v)
18
		}
19
	}
20
	const response = await fetch(url, {
21
		method: 'GET',
22
		headers: {
23
			Authorization: 'Bearer ' + auth.apiKey
24
		},
25
		body: undefined
26
	})
27
	if (!response.ok) {
28
		const text = await response.text()
29
		throw new Error(`${response.status} ${text}`)
30
	}
31
	return await response.json()
32
}
33