Class ApplicationsApi

Hierarchy

VoiceDomainApi
- ApplicationsApi

Index

Methods

assignNumbers getCallbackURLs listNumbers queryNumber setBasePath unassignNumber updateCallbackURLs

Methods

assignNumbers

assignNumbers(data: AssignNumbersRequestData): Promise<void>
Update Numbers Assign a number or a list of numbers to an application.
Parameters
- data: AssignNumbersRequestData
  The data to provide to the API call.
Returns Promise<void>

getCallbackURLs

getCallbackURLs(data: GetCallbackURLsRequestData): Promise<GetCallbacks>
Get Callback URLs Returns any callback URLs configured for the specified application.
Parameters
- data: GetCallbackURLsRequestData
  The data to provide to the API call.
Returns Promise<GetCallbacks>

listNumbers

listNumbers(data: GetNumbersRequestData): Promise<ListNumbersResponse>
Get Numbers Get information about your numbers. It returns a list of numbers that you own, as well as their capability (voice or SMS). For the ones that are assigned to an app, it returns the application key of the app.
Parameters
- data: GetNumbersRequestData
  The data to provide to the API call.
Returns Promise<ListNumbersResponse>

queryNumber

queryNumber(data: QueryNumberRequestData): Promise<QueryNumberResponse>
Query number Returns information about the requested number.
Parameters
- data: QueryNumberRequestData
  The data to provide to the API call.
Returns Promise<QueryNumberResponse>

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 VoiceDomainApi.setBasePath

unassignNumber

unassignNumber(data: UnassignNumberRequestData): Promise<void>
Un-assign number Un-assign a number from an application.
Parameters
- data: UnassignNumberRequestData
  The data to provide to the API call.
Returns Promise<void>

updateCallbackURLs

updateCallbackURLs(data: UpdateCallbackURLsRequestData): Promise<void>
Update Callbacks Update the configured callback URLs for the specified application.
Parameters
- data: UpdateCallbackURLsRequestData
  The data to provide to the API call.
Returns Promise<void>