> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt

# PhoneNumber

## Functions

### getInfo

Get the phone number info.

```ts
getInfo(number: string, country?: string): Info
```

**Parameters**

**`number`** `string` — required

---

**`country`** `string`

---

## Types

### Info

**`error`** `string`

*optional*

Optional. Error string. Possible values are: INVALID\_COUNTRY\_CODE, NOT\_A\_NUMBER, TOO\_SHORT\_AFTER\_IDD, TOO\_SHORT\_NSN, TOO\_LONG\_NSN

---

**`isPossibleNumber`** `boolean`

Whether the number is possible in specified country (just by analyzing length information)

---

**`isValidNumber`** `boolean`

Whether the number is valid in specified country

---

**`isValidNumberForRegion`** `boolean`

Whether the number is valid in detected region

---

**`location`** `string`

The phone number's city, state and country. If the city (or state) is unavailable, only state and country (or just country) is shown

---

**`number`** `string`

Number in international E.164 format, starting with +

---

**`numberType`** `string`

Number type, one of: FIXED\_LINE, MOBILE, FIXED\_LINE\_OR\_MOBILE, TOLL\_FREE, PREMIUM\_RATE, SHARED\_COST, VOIP, PERSONAL\_NUMBER, PAGER, UAN, VOICEMAIL, UNKNOWN

---

**`region`** `string`

2-letter country code of specified phone number (ISO 3166-1)

---