Class ActiveNumberApi

Hierarchy

NumbersDomainApi
- ActiveNumberApi

Index

Methods

get list release setBasePath update

Methods

get

get(data: GetActiveNumberRequestData): Promise<ActiveNumber>
Get active Number Get a virtual number
Parameters
- data: GetActiveNumberRequestData
  The data to provide to the API call.
Returns Promise<ActiveNumber>

list

list(data: ListActiveNumbersRequestData): ApiListPromise<ActiveNumber>
List active numbers Lists all virtual numbers for a project.
Parameters
- data: ListActiveNumbersRequestData
  The data to provide to the API call.
Returns ApiListPromise<ActiveNumber>

release

release(data: ReleaseNumberRequestData): Promise<ActiveNumber>
Release number With this endpoint, you can cancel your subscription for a specific virtual phone number.
Parameters
- data: ReleaseNumberRequestData
  The data to provide to the API call.
Returns Promise<ActiveNumber>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from NumbersDomainApi.setBasePath

update

update(data: UpdateActiveNumberRequestData): Promise<ActiveNumber>
Update active number Update a virtual phone number. For example: you can configure SMS/Voice services or set a friendly name. To update the name that displays, modify the `displayName` parameter. You'll use `smsConfiguration` to update your SMS configuration and `voiceConfiguration` to update the voice configuration.
Parameters
- data: UpdateActiveNumberRequestData
  The data to provide to the API call.
Returns Promise<ActiveNumber>