Class PhoneNumbersResource

Provisioned phone numbers and the gateways attached to them.

Index

Constructors

Methods

create detach get list release updateGateway

Constructors

constructor

new PhoneNumbersResource(http: HttpClient): PhoneNumbersResource
Parameters
- http: HttpClient
Returns PhoneNumbersResource

Methods

create

create(options: CreatePhoneNumbersOptions): Promise<MessageResponse>
Provision numbers and attach inbound + outbound gateways.
Parameters
- options: CreatePhoneNumbersOptions
Returns Promise<MessageResponse>

detach

detach(phoneNumber: string): Promise<MessageResponse>
Detach a number from its gateways.
Parameters
- phoneNumber: string
Returns Promise<MessageResponse>

get

get(number: string): Promise<PhoneNumberWithGateways>
Fetch a single number (by E.164) with its gateways.
Parameters
- number: string
Returns Promise<PhoneNumberWithGateways>

list

list(params?: ListPhoneNumbersParams): Promise<Page<PhoneNumberWithGateways>>
Parameters
- params: ListPhoneNumbersParams = {}
Returns Promise<Page<PhoneNumberWithGateways>>

release

release(phoneNumberId: string): Promise<MessageResponse>
Release a phone number (provider + billing side effects).
Parameters
- phoneNumberId: string
Returns Promise<MessageResponse>

updateGateway

updateGateway(
gatewayId: string,
options: UpdatePhoneNumberGatewayOptions,
): Promise<MessageResponse>
Update a phone number's gateway.
Parameters
- gatewayId: string
- options: UpdatePhoneNumberGatewayOptions
Returns Promise<MessageResponse>