[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Numbers # Vonage Number SDK for Node.js ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/numbers?label=%40vonage%2Fnumbers&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license] Vonage This is the Vonage Number SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup]. For full API documentation refer to [developer.nexmo.com](https://developer.nexmo.com/). If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/numbers/v2_TO_v3_MIGRATION_GUIDE.md) * [Installation](#installation) * [Usage](#usage) * [Promises](#promises) * [Testing](#testing) ## Installation We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation. You can also use this SDK standalone if you only need access to just the Numbers API. ### With NPM ```bash npm install @vonage/numbers ``` ### With Yarn ```bash yarn add @vonage/numbers ``` ## Usage ### As part of the Vonage Server SDK If you are using this SDK as part of the Vonage Server SDK, you can access it as the `numbers` property off of the client that you instantiate. ```js const { Vonage, Auth } = require('@vonage/server-sdk'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const vonage = new Vonage(credentials, options); vonage.numbers.getAvailableNumbers() .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ### Standalone The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Numbers API. All you need to do is `require('@vonage/numbers')`, and use the returned object to create your own client. ```js const { Auth } = require('@vonage/auth'); const { Numbers } = require('@vonage/numbers'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const numbersClient = new Numbers(credentials, options); ``` Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options) ## Promises Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response. ```js const resp = await vonage.numbers.basicLookup(PHONE_NUMBER) vonage.numbers.getAvailableNumbers() .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ## Testing Run: ```bash npm run test ``` [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk [license]: _media/LICENSE.txt ## Enumerations ### Feature Defined in: [numbers/lib/enums/Feature.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/Feature.ts#L4) Enumeration of features for a virtual number. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `MMS` | `"MMS"` | Supports Multimedia Messaging Service (MMS). | [numbers/lib/enums/Feature.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/Feature.ts#L8) | | `SMS` | `"SMS"` | Supports Short Message Service (SMS). | [numbers/lib/enums/Feature.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/Feature.ts#L13) | | `VOICE` | `"VOICE"` | Supports Voice calling. | [numbers/lib/enums/Feature.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/Feature.ts#L18) | *** ### LineType Defined in: [numbers/lib/enums/LineType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/LineType.ts#L4) Enumeration of line types for virtual numbers. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `LANDLINE` | `"landline"` | Landline type. | [numbers/lib/enums/LineType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/LineType.ts#L8) | | `LANDLINE_TOLL_FREE` | `"landline-toll-free"` | Landline toll-free type. | [numbers/lib/enums/LineType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/LineType.ts#L18) | | `MOBILE_LVN` | `"mobile-lvn"` | Mobile LVN (Local Virtual Number) type. | [numbers/lib/enums/LineType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/LineType.ts#L13) | *** ### MessagesCallbackTypeEnum Defined in: [numbers/lib/enums/MessagesCallbackTypeEnum.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/MessagesCallbackTypeEnum.ts#L4) Enumeration of messages callback types. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `App` | `"app"` | Callback type for an application. | [numbers/lib/enums/MessagesCallbackTypeEnum.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/MessagesCallbackTypeEnum.ts#L8) | *** ### SearchPattern Defined in: [numbers/lib/enums/SearchPattern.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/SearchPattern.ts#L4) Enumeration of search patterns. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `CONTAINS` | `1` | Indicates a search for values that contain the given pattern. | [numbers/lib/enums/SearchPattern.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/SearchPattern.ts#L13) | | `ENDS_WITH` | `2` | Indicates a search for values that end with the given pattern. | [numbers/lib/enums/SearchPattern.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/SearchPattern.ts#L18) | | `START_WITH` | `0` | Indicates a search for values that start with the given pattern. | [numbers/lib/enums/SearchPattern.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/SearchPattern.ts#L8) | *** ### VoiceCallbackTypeEnum Defined in: [numbers/lib/enums/VoiceCallbackTypeEnum.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/VoiceCallbackTypeEnum.ts#L4) Enumeration of voice callback types. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `App` | `"app"` | Callback type for an application. | [numbers/lib/enums/VoiceCallbackTypeEnum.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/VoiceCallbackTypeEnum.ts#L18) | | `Sip` | `"sip"` | Callback type for SIP. | [numbers/lib/enums/VoiceCallbackTypeEnum.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/VoiceCallbackTypeEnum.ts#L8) | | `Tel` | `"tel"` | Callback type for telephone (tel). | [numbers/lib/enums/VoiceCallbackTypeEnum.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/enums/VoiceCallbackTypeEnum.ts#L13) | ## Classes ### Numbers Defined in: [numbers/lib/numbers.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L123) Client for buying, canceling, and searching for phone numbers. #### Examples Create a standalone Numbers client ```ts import { Numbers } from '@vonage/numbers'; const numbersClient = new Numbers({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); ``` Create an Numbers client from the Vonage client ```ts import { Vonage } from '@vonage/server-client'; const vonage = new Vonage({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); const numbersClient = vonage.numbers; ``` #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new Numbers(credentials, options?): Numbers; ``` Defined in: server-client/dist/lib/client.d.ts:35 Creates a new instance of the Client. ###### Parameters ###### credentials The authentication credentials or an authentication instance. [`AuthParams`](Vonage-Auth.md#authparams) | [`AuthInterface`](Vonage-Auth.md#authinterface) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`Numbers`](#numbers) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor) #### Properties ##### auth ```ts protected auth: AuthInterface; ``` Defined in: server-client/dist/lib/client.d.ts:24 The authentication instance responsible for generating authentication headers and query parameters. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth) ##### authType ```ts protected authType: AuthenticationType = AuthenticationType.BASIC; ``` Defined in: [numbers/lib/numbers.ts:127](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L127) ###### See [Client.authType](Vonage-Messages.md#messages#authtype) ###### Overrides [`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype) ##### config ```ts protected config: ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:28 Configuration settings for the client, including default hosts for various services and other request settings. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config) ##### transformers ```ts static transformers: object; ``` Defined in: server-client/dist/lib/client.d.ts:11 Static property containing utility transformers. ###### camelCaseObjectKeys ```ts camelCaseObjectKeys: PartialTransformFunction; ``` ###### kebabCaseObjectKeys ```ts kebabCaseObjectKeys: PartialTransformFunction; ``` ###### omit() ```ts omit: (keys, obj) => TransformedObject; ``` ###### Parameters ###### keys `string`[] ###### obj [`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform) ###### Returns [`TransformedObject`](Vonage-Server-Client.md#transformedobject) ###### snakeCaseObjectKeys ```ts snakeCaseObjectKeys: PartialTransformFunction; ``` ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers) #### Methods ##### addAuthenticationToRequest() ```ts addAuthenticationToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:43 Adds the appropriate authentication headers or parameters to the request based on the authentication type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest) ##### addBasicAuthToRequest() ```ts protected addBasicAuthToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:71 Adds basic authentication headers to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest) ##### addJWTToRequest() ```ts protected addJWTToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:64 Adds a JWT to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest) ##### addQueryKeySecretToRequest() ```ts protected addQueryKeySecretToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:57 Adds API key and secret to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest) ##### addQueryKeySecretToRequestBody() ```ts protected addQueryKeySecretToRequestBody(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:50 Adds API key and secret to the request body. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody) ##### buyNumber() ```ts buyNumber(params): Promise; ``` Defined in: [numbers/lib/numbers.ts:152](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L152) Buy a phone number. ###### Parameters ###### params [`NumbersParams`](#numbersparams) The parameters for buying a number. ###### Returns `Promise`\<[`NumbersEmptyResponse`](#numbersemptyresponse)\> A promise that resolves to an empty response or an error response. ###### Example Buy a phone number ```ts import { Country } from '@vonage/numbers'; const resp = await numbersClient.buyNumber({ country: Country.US, msisdn: '15555555555' }); if (resp.errorCode) { console.log(`Error: ${resp.errorCodeLabel}`); } else { console.log('Number bought successfully'); } ``` ##### cancelNumber() ```ts cancelNumber(params): Promise; ``` Defined in: [numbers/lib/numbers.ts:188](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L188) Cancel a phone number. ###### Parameters ###### params [`NumbersParams`](#numbersparams) The parameters for canceling a number. ###### Returns `Promise`\<[`NumbersEmptyResponse`](#numbersemptyresponse)\> A promise that resolves to an empty response or an error response. ###### Example Cancel a phone number ```ts const resp = await numbersClient.cancelNumber({ msisdn: '15555555555' }); if (resp.errorCode) { console.log(`Error: ${resp.errorCodeLabel}`); } else { console.log('Number cancled successfully'); } ``` ##### getAvailableNumbers() ```ts getAvailableNumbers(filter): Promise; ``` Defined in: [numbers/lib/numbers.ts:226](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L226) Retrieves a list of available phone numbers based on the provided filter criteria. ###### Parameters ###### filter [`NumbersSearchFilter`](#numberssearchfilter) The filter criteria for searching available numbers. ###### Returns `Promise`\<[`NumbersAvailableList`](#numbersavailablelist)\> A promise that resolves to a list of available phone numbers or an error response. ###### Example Search for available numbers that can send SMS and make voice calls ```ts import { Country, Feature } from '@vonage/numbers'; const resp = await numbersClient.getAvailableNumbers({ country: Country.US, features: [Feature.SMS, Feature.VOICE], }); console.log(`There are ${resp.count} numbers available`); for (const number of resp.numbers) { console.log(number.msisdn); console.log(number.cost); console.log(number.type); } ``` ##### getConfig() ```ts getConfig(): ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:36 ###### Returns [`ConfigParams`](Vonage-Server-Client.md#configparams) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig) ##### getOwnedNumbers() ```ts getOwnedNumbers(filter?): Promise; ``` Defined in: [numbers/lib/numbers.ts:268](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L268) Retrieves a list of owned phone numbers based on the provided filter criteria. ###### Parameters ###### filter? [`NumbersOwnedFilter`](#numbersownedfilter) The filter criteria for searching owned numbers. ###### Returns `Promise`\<[`NumbersOwnedList`](#numbersownedlist)\> A promise that resolves to a list of owned phone numbers or an error response. ###### Example Search for owned numbers ```ts const resp = await numbersClient.getOwnedNumbers(); console.log(`There are ${resp.count} numbers owned`); for (const number of resp.numbers) { console.log(number.msisdn); console.log(number.type); } ``` ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:168 Parses the response based on its content type. ###### Type Parameters ###### T `T` The expected type of the parsed response data. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### response `Response` The raw response from the request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse) ##### prepareBody() ```ts protected prepareBody(request): undefined | string; ``` Defined in: server-client/dist/lib/client.d.ts:158 Prepares the body for the request based on the content type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### Returns `undefined` \| `string` - The prepared request body as a string or undefined. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody) ##### prepareRequest() ```ts protected prepareRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:151 Prepares the request with necessary headers, authentication, and query parameters. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The initial request options. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The modified request options. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest) ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:78 Sends a DELETE request to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the DELETE request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the DELETE request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest) ##### sendFormSubmitRequest() ```ts sendFormSubmitRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:86 Sends a POST request with form data to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? `Record`\<`string`, `undefined` \| `string`\> Optional payload containing form data to send with the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest) ##### sendGetRequest() ```ts sendGetRequest(url, queryParams?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:94 Sends a GET request to the specified URL with optional query parameters. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the GET request. ###### queryParams? Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the GET request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest) ##### sendPatchRequest() ```ts sendPatchRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:104 Sends a PATCH request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PATCH request. ###### payload? Optional payload to be sent as the body of the PATCH request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PATCH request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest) ##### sendPostRequest() ```ts sendPostRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:114 Sends a POST request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? Optional payload to be sent as the body of the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest) ##### sendPutRequest() ```ts sendPutRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:124 Sends a PUT request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PUT request. ###### payload? Optional payload to be sent as the body of the PUT request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PUT request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest) ##### sendRequest() ```ts sendRequest(request): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:144 Sends a request adding necessary headers, handling authentication, and parsing the response. ###### Type Parameters ###### T `T` ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The options defining the request, including URL, method, headers, and data. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest) ##### sendRequestWithData() ```ts sendRequestWithData( method, url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:135 Sends a request with JSON-encoded data to the specified URL using the provided HTTP method. ###### Type Parameters ###### T `T` ###### Parameters ###### method The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable). [`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch) ###### url `string` The URL endpoint for the request. ###### payload? Optional payload to be sent as the body of the request, JSON-encoded. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata) ##### updateNumber() ```ts updateNumber(params?): Promise; ``` Defined in: [numbers/lib/numbers.ts:304](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/numbers.ts#L304) Updates the settings of a phone number. ###### Parameters ###### params? [`NumbersUpdateParams`](#numbersupdateparams) The parameters for updating a phone number. ###### Returns `Promise`\<[`NumbersEmptyResponse`](#numbersemptyresponse)\> A promise that resolves to an empty response or an error response. ###### Example ```ts const resp = await numbersClient.updateNumber({ msisdn: '15555555555', voiceCallbackType: 'app', voiceCallbackValue: 'APPLICATION_ID', voiceStatusCallback: 'https://example.com/webhooks/voice', }); if (resp.errorCode) { console.log(`Error: ${resp.errorCodeLabel}`); } else { console.log('Number bought successfully'); } ``` ## Type Aliases ### Country ```ts type Country = | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | string; ``` Defined in: [numbers/lib/types/Country.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/Country.ts#L4) ISO 3166-1 alpha-2 country codes. *** ### NumbersAvailableList ```ts type NumbersAvailableList = object; ``` Defined in: [numbers/lib/types/NumbersAvailableList.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableList.ts#L6) Represents a list of available numbers. #### Properties ##### count? ```ts optional count: number; ``` Defined in: [numbers/lib/types/NumbersAvailableList.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableList.ts#L10) The total count of available numbers. ##### numbers? ```ts optional numbers: NumbersAvailableNumber[]; ``` Defined in: [numbers/lib/types/NumbersAvailableList.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableList.ts#L15) An array of available numbers and their details. *** ### NumbersAvailableNumber ```ts type NumbersAvailableNumber = object; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L7) Represents an available phone number with its details. #### Properties ##### cost? ```ts optional cost: string; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L30) The cost associated with the phone number. Example: "$10.00". ##### country? ```ts optional country: Country; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### features? ```ts optional features: Feature[]; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L36) The capabilities/features of the phone number, such as SMS, VOICE, or MMS. Example: ["SMS", "VOICE"]. ##### msisdn? ```ts optional msisdn: string; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L18) An available inbound virtual phone number. Example: "447700900000". ##### type? ```ts optional type: LineType; ``` Defined in: [numbers/lib/types/NumbersAvailableNumber.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersAvailableNumber.ts#L24) The type of phone number. Example: "mobile-lvn" or "landline". *** ### ~~NumbersClassParameters~~ ```ts type NumbersClassParameters = AuthParams & VetchOptions & object; ``` Defined in: [numbers/lib/types/NumbersClassParameters.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersClassParameters.ts#L9) Represents the parameters for configuring the NumbersClass. #### Type declaration ##### ~~auth?~~ ```ts optional auth: AuthInterface; ``` The authentication configuration. #### Deprecated This is no longer in use *** ### NumbersEmptyResponse ```ts type NumbersEmptyResponse = object; ``` Defined in: [numbers/lib/types/NumbersEmptyResponse.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersEmptyResponse.ts#L4) Represents a response with optional error code and label for empty number-related operations. #### Properties ##### error-code? ```ts optional error-code: 200 | 401 | number; ``` Defined in: [numbers/lib/types/NumbersEmptyResponse.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersEmptyResponse.ts#L21) The error code, if an error occurred during the operation. Example: "E001". ##### error-code-label? ```ts optional error-code-label: string; ``` Defined in: [numbers/lib/types/NumbersEmptyResponse.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersEmptyResponse.ts#L27) A human-readable label or description of the error code. Example: "Invalid request." ##### errorCode? ```ts optional errorCode: string; ``` Defined in: [numbers/lib/types/NumbersEmptyResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersEmptyResponse.ts#L9) The error code, if an error occurred during the operation. Example: "E001". ##### errorCodeLabel? ```ts optional errorCodeLabel: string; ``` Defined in: [numbers/lib/types/NumbersEmptyResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersEmptyResponse.ts#L15) A human-readable label or description of the error code. Example: "Invalid request." *** ### NumbersOwnedFilter ```ts type NumbersOwnedFilter = object; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L7) Represents filters for searching owned numbers. #### Properties ##### applicationId? ```ts optional applicationId: string; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L18) An Application ID. Example: "aaaaaaaa-bbbb-cccc-dddd-0123456789ab". ##### country? ```ts optional country: Country; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### hasApplication? ```ts optional hasApplication: boolean; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L23) Indicates whether numbers have an associated application. ##### index? ```ts optional index: number; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L44) The starting index for paginated results. ##### pattern? ```ts optional pattern: string; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L28) A pattern to filter numbers. ##### searchPattern? ```ts optional searchPattern: SearchPattern; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L34) The search pattern type. Example: SearchPattern.START_WITH. ##### size? ```ts optional size: number; ``` Defined in: [numbers/lib/types/NumbersOwnedFilter.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedFilter.ts#L39) The maximum number of results to return. *** ### NumbersOwnedList ```ts type NumbersOwnedList = object; ``` Defined in: [numbers/lib/types/NumbersOwnedList.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedList.ts#L6) Represents a list of owned numbers. #### Properties ##### count? ```ts optional count: number; ``` Defined in: [numbers/lib/types/NumbersOwnedList.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedList.ts#L10) The total count of owned numbers. ##### numbers? ```ts optional numbers: NumbersOwnedNumber[]; ``` Defined in: [numbers/lib/types/NumbersOwnedList.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedList.ts#L15) An array of owned numbers and their details. *** ### NumbersOwnedNumber ```ts type NumbersOwnedNumber = object; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L7) Represents an owned phone number with its details. #### Properties ##### country? ```ts optional country: Country; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### features? ```ts optional features: Feature[]; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:36](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L36) The capabilities/features of the phone number, such as SMS, VOICE, or MMS. Example: ["SMS", "VOICE"]. ##### messagesCallbackType? ```ts optional messagesCallbackType: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L54) The type of messages callback for the number. Example: "app". ##### messagesCallbackValue? ```ts optional messagesCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L60) The value associated with the messages callback. Example: "aaaaaaaa-bbbb-cccc-dddd-0123456789ab". ##### moHttpUrl? ```ts optional moHttpUrl: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L24) The URL of the webhook endpoint that handles inbound messages for the number. Example: "https://example.com/webhooks/inbound-sms". ##### msisdn? ```ts optional msisdn: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L18) The owned phone number. Example: "447700900000". ##### type? ```ts optional type: LineType; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L30) The type of phone number. Example: "mobile-lvn" or "landline". ##### voiceCallbackType? ```ts optional voiceCallbackType: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L42) The type of voice callback for the number. Example: "app" or "sip". ##### voiceCallbackValue? ```ts optional voiceCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersOwnedNumber.ts:48](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersOwnedNumber.ts#L48) The value associated with the voice callback. Example: "aaaaaaaa-bbbb-cccc-dddd-0123456789ab". *** ### NumbersParams ```ts type NumbersParams = object; ``` Defined in: [numbers/lib/types/NumbersParams.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersParams.ts#L6) Represents parameters for configuring a phone number. #### Properties ##### country ```ts country: Country; ``` Defined in: [numbers/lib/types/NumbersParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersParams.ts#L11) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### msisdn ```ts msisdn: string; ``` Defined in: [numbers/lib/types/NumbersParams.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersParams.ts#L17) The phone number. Example: "447700900000". ##### targetApiKey? ```ts optional targetApiKey: string; ``` Defined in: [numbers/lib/types/NumbersParams.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersParams.ts#L22) An optional target API key. *** ### NumbersQueryOwnedFilter ```ts type NumbersQueryOwnedFilter = object; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L6) Represents filters for querying owned numbers. #### Properties ##### application\_id? ```ts optional application_id: string; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L17) An Application ID. Example: "aaaaaaaa-bbbb-cccc-dddd-0123456789ab". ##### country? ```ts optional country: Country; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L11) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### has\_application? ```ts optional has_application: boolean; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L22) Indicates whether numbers have an associated application. ##### index? ```ts optional index: number; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L43) The starting index for paginated results. ##### pattern? ```ts optional pattern: string; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L27) A pattern to filter numbers. ##### search\_pattern? ```ts optional search_pattern: number; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L33) The search pattern type. Example: 0 for "START_WITH". ##### size? ```ts optional size: number; ``` Defined in: [numbers/lib/types/NumbersQueryOwnedFilter.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryOwnedFilter.ts#L38) The maximum number of results to return. *** ### NumbersQueryParams ```ts type NumbersQueryParams = object; ``` Defined in: [numbers/lib/types/NumbersQueryParams.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryParams.ts#L6) Represents parameters for querying phone numbers. #### Properties ##### country ```ts country: Country; ``` Defined in: [numbers/lib/types/NumbersQueryParams.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryParams.ts#L11) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### msisdn ```ts msisdn: string; ``` Defined in: [numbers/lib/types/NumbersQueryParams.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryParams.ts#L17) The phone number. Example: "447700900000". ##### target\_api\_key? ```ts optional target_api_key: string; ``` Defined in: [numbers/lib/types/NumbersQueryParams.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryParams.ts#L22) An optional target API key. *** ### NumbersQuerySearchFilter ```ts type NumbersQuerySearchFilter = object; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L6) Represents filters for searching phone numbers. #### Properties ##### country? ```ts optional country: Country; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L11) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### index? ```ts optional index: number; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L32) The starting index for paginated results. ##### pattern? ```ts optional pattern: string; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:16](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L16) A pattern to filter numbers. ##### search\_pattern? ```ts optional search_pattern: number; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L22) The search pattern type. Example: 0 for "START_WITH". ##### size? ```ts optional size: number; ``` Defined in: [numbers/lib/types/NumbersQuerySearchFilter.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQuerySearchFilter.ts#L27) The maximum number of results to return. *** ### NumbersQueryUpdateParams ```ts type NumbersQueryUpdateParams = object; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L7) Represents parameters for updating phone number settings. #### Properties ##### app\_id? ```ts optional app_id: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L24) An Application ID. Example: "aaaaaaaa-bbbb-cccc-dddd-0123456789ab". ##### country ```ts country: Country; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### ~~messagesCallbackType?~~ ```ts optional messagesCallbackType: MessagesCallbackTypeEnum; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:55](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L55) The messages callback type. ###### Deprecated ##### ~~messagesCallbackValue?~~ ```ts optional messagesCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:61](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L61) The messages callback value. ###### Deprecated ##### moHttpUrl? ```ts optional moHttpUrl: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L29) The HTTP URL for handling MO (Mobile Originated) messages. ##### moSmppSysType? ```ts optional moSmppSysType: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L34) The SMPP system type for MO (Mobile Originated) messages. ##### msisdn ```ts msisdn: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L18) The phone number. Example: "447700900000". ##### voiceCallbackType? ```ts optional voiceCallbackType: VoiceCallbackTypeEnum; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L39) The voice callback type. ##### voiceCallbackValue? ```ts optional voiceCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L44) The voice callback value. ##### voiceStatusCallback? ```ts optional voiceStatusCallback: string; ``` Defined in: [numbers/lib/types/NumbersQueryUpdateParams.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersQueryUpdateParams.ts#L49) The voice status callback URL. *** ### NumbersResponse\ ```ts type NumbersResponse = VetchResponse; ``` Defined in: [numbers/lib/types/NumbersResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersResponse.ts#L7) Represents a response for phone numbers. #### Type Parameters ##### T `T` The type of the response data. *** ### NumbersSearchFilter ```ts type NumbersSearchFilter = object; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L7) Represents filters for searching phone numbers. #### Properties ##### country ```ts country: Country; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### features? ```ts optional features: Feature[]; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L33) The capabilities or features of the number. ##### index? ```ts optional index: number; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L43) The starting index for paginated results. ##### pattern? ```ts optional pattern: string; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L22) A pattern to filter numbers. ##### searchPattern? ```ts optional searchPattern: SearchPattern; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L28) The search pattern type. Example: 0 for "START_WITH". ##### size? ```ts optional size: number; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L38) The maximum number of results to return. ##### type? ```ts optional type: LineType; ``` Defined in: [numbers/lib/types/NumbersSearchFilter.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchFilter.ts#L17) The type of the phone number. *** ### NumbersSearchSimple ```ts type NumbersSearchSimple = object; ``` Defined in: [numbers/lib/types/NumbersSearchSimple.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchSimple.ts#L4) Represents simple search options for phone numbers. #### Properties ##### contains? ```ts optional contains: string; ``` Defined in: [numbers/lib/types/NumbersSearchSimple.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchSimple.ts#L18) Filter numbers that contain a specific string. ##### endsWith? ```ts optional endsWith: string; ``` Defined in: [numbers/lib/types/NumbersSearchSimple.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchSimple.ts#L13) Filter numbers that end with a specific string. ##### startsWith? ```ts optional startsWith: string; ``` Defined in: [numbers/lib/types/NumbersSearchSimple.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersSearchSimple.ts#L8) Filter numbers that start with a specific string. *** ### NumbersUpdateParams ```ts type NumbersUpdateParams = object; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L7) Represents parameters for updating phone numbers. #### Properties ##### appId? ```ts optional appId: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L29) The application ID associated with the phone number. ##### ~~applicationId?~~ ```ts optional applicationId: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L24) The application ID associated with the phone number. ###### Deprecated Please use app_id ##### country ```ts country: Country; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L12) The two-character country code in ISO 3166-1 alpha-2 format. Example: "US" for the United States. ##### ~~messagesCallbackType?~~ ```ts optional messagesCallbackType: MessagesCallbackTypeEnum; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:61](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L61) The type of messages callback: "app". ###### Deprecated Use voiceCallbackType instead. ##### ~~messagesCallbackValue?~~ ```ts optional messagesCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:67](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L67) The value for messages callback. ###### Deprecated Use voiceCallbackValue instead. ##### moHttpUrl? ```ts optional moHttpUrl: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L34) The URL of the webhook endpoint that handles inbound messages. ##### moSmppSysType? ```ts optional moSmppSysType: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L39) The system type for SMPP MO messages. ##### msisdn ```ts msisdn: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L18) The phone number in E.164 format. Example: "+1234567890". ##### voiceCallbackType? ```ts optional voiceCallbackType: VoiceCallbackTypeEnum; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:44](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L44) The type of voice callback: "sip", "tel", or "app". ##### voiceCallbackValue? ```ts optional voiceCallbackValue: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:49](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L49) The value for voice callback. ##### voiceStatusCallback? ```ts optional voiceStatusCallback: string; ``` Defined in: [numbers/lib/types/NumbersUpdateParams.ts:54](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/numbers/lib/types/NumbersUpdateParams.ts#L54) The URL of the voice status callback.