Class NumbersService

ReadonlyactiveNumber

ReadonlyavailableNumber

ReadonlyavailableRegions

Readonlycallbacks

checkAvailability

• checkAvailability(data: GetAvailableNumberRequestData): Promise<AvailableNumber>

  This endpoint allows you to enter a specific phone number to check if it's available for use. A 200 response will return the number's capability, setup costs, monthly costs and if supporting documentation is required. If the phone number is not available, the API will return a 404 error.

  Parameters

  • data: GetAvailableNumberRequestData

    The data to provide to the API call.

  Returns Promise<AvailableNumber>

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>

  Retrieve a virtual number's details

  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>

  Lists all virtual numbers for a project.

  Parameters

  • data: 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>

rent

• rent(data: RentNumberRequestData): Promise<ActiveNumber>

  Rent a virtual number to use with SMS products, Voice products, or both. You'll use 'smsConfiguration' to set up your number for SMS and 'voiceConfiguration' for Voice.

  Parameters

  • data: RentNumberRequestData

    The data to provide to the API call.

  Returns Promise<ActiveNumber>

rentAny

• rentAny(data: RentAnyNumberRequestData): Promise<ActiveNumber>

  Rent any virtual number that matches the criteria (Search for and activate an available Sinch virtual number all in one API call).

  Parameters

  • data: RentAnyNumberRequestData

    The data to provide to the API call.

  Returns Promise<ActiveNumber>

searchForAvailableNumbers

• searchForAvailableNumbers(
      data: ListAvailableNumbersRequestData,
  ): Promise<AvailableNumbersResponse>

  Search for virtual numbers that are available for you to activate. You can filter by any property on the available number resource.

  Parameters

  • data: ListAvailableNumbersRequestData

    The data to provide to the API call.

  Returns Promise<AvailableNumbersResponse>

setApiClientConfig

• setApiClientConfig(newParams: SinchClientParameters): void

  Parameters

  • newParams: SinchClientParameters

  Returns void

setCredentials

• setCredentials(credentials: Partial<UnifiedCredentials>): void

  Parameters

  • credentials: Partial<UnifiedCredentials>

  Returns void

setHostname

• setHostname(hostname: string): void

  Update the default hostname for each API

  Parameters

  • hostname: string

    The new hostname to use for all the APIs.

  Returns void

update

• update(data: UpdateActiveNumberRequestData): Promise<ActiveNumber>

  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>