Class ActiveNumberApi

Index

Methods

deprovisionEmergencyAddress get getEmergencyAddress list provisionEmergencyAddress release update validateEmergencyAddress

Methods

deprovisionEmergencyAddress

deprovisionEmergencyAddress(
data: DeprovisionEmergencyAddressRequestData,
): Promise<void>
Remove the emergency address for a number. With this endpoint, you can deprovision the emergency address associated with this number.
Parameters
- data: DeprovisionEmergencyAddressRequestData
  The data to provide to the API call.
Returns Promise<void>

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>

getEmergencyAddress

getEmergencyAddress(
data: GetEmergencyAddressRequestData,
): Promise<EmergencyAddress>
Get the emergency address for a number With this endpoint, you can retrieve the emergency address associated with this number.
Parameters
- data: GetEmergencyAddressRequestData
  The data to provide to the API call.
Returns Promise<EmergencyAddress>

list

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

provisionEmergencyAddress

provisionEmergencyAddress(
data: ProvisionEmergencyAddressRequestData,
): Promise<EmergencyAddress>
Add a emergency address for a number With this endpoint, you can provision an emergency address associated with this number.
Parameters
- data: ProvisionEmergencyAddressRequestData
  The data to provide to the API call.
Returns Promise<EmergencyAddress>

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>

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>

validateEmergencyAddress

validateEmergencyAddress(
data: ValidateEmergencyAddressRequestData,
): Promise<ValidateEmergencyAddressResponse>
Validate the emergency address for a number. With this endpoint, you can validate the emergency address associated with this number.
Parameters
- data: ValidateEmergencyAddressRequestData
  The data to provide to the API call.
Returns Promise<ValidateEmergencyAddressResponse>