Class PhoneControllerApi

Hierarchy

Constructors

Properties

Methods

acquirePhonePoolLease acquirePhonePoolLeaseRaw addAllPhoneNumbersToPhonePool addAllPhoneNumbersToPhonePoolRaw addPhoneNumberTags addPhoneNumberTagsRaw addPhoneNumbersToPhonePool addPhoneNumbersToPhonePoolRaw createEmergencyAddress createEmergencyAddressRaw createPhoneNumber createPhoneNumberRaw createPhonePool createPhonePoolRaw createPhoneProvisioningJob createPhoneProvisioningJobRaw deleteAllPhoneNumber deleteAllPhoneNumberRaw deleteEmergencyAddress deleteEmergencyAddressRaw deletePhoneMessageThreadItems deletePhoneMessageThreadItemsRaw deletePhoneNumber deletePhoneNumberRaw deletePhonePool deletePhonePoolRaw getAllPhoneMessageThreads getAllPhoneMessageThreadsRaw getAllPhoneNumberReleases getAllPhoneNumberReleasesRaw getConsentStatus getConsentStatusRaw getEmergencyAddress getEmergencyAddressRaw getEmergencyAddresses getEmergencyAddressesRaw getOrCreatePhonePool getOrCreatePhonePoolRaw getPhoneMessageThreadItems getPhoneMessageThreadItemsRaw getPhoneMessageThreads getPhoneMessageThreadsRaw getPhoneNumber getPhoneNumberByName getPhoneNumberByNameRaw getPhoneNumberByPhoneNumber getPhoneNumberByPhoneNumberRaw getPhoneNumberLineTypeIntelligence getPhoneNumberLineTypeIntelligenceRaw getPhoneNumberRaw getPhoneNumberRelease getPhoneNumberReleaseRaw getPhoneNumberTags getPhoneNumberTagsRaw getPhoneNumbers getPhoneNumbersRaw getPhonePlans getPhonePlansAvailability getPhonePlansAvailabilityRaw getPhonePlansRaw getPhonePool getPhonePoolByName getPhonePoolByNameRaw getPhonePoolRaw getPhonePools getPhonePoolsRaw getPhoneProvisioningCapabilities getPhoneProvisioningCapabilitiesRaw getPhoneProvisioningJob getPhoneProvisioningJobRaw getPhoneSmsPrepaidCredit getPhoneSmsPrepaidCreditRaw getPhoneSmsPrepaidCredits getPhoneSmsPrepaidCreditsRaw getPhoneSummary getPhoneSummaryRaw getPhoneTags getPhoneTagsRaw getSentSmsByPhoneNumber getSentSmsByPhoneNumberRaw getSmsByPhoneNumber getSmsByPhoneNumberRaw reassignPhoneNumberRelease reassignPhoneNumberReleaseRaw releasePhonePoolLease releasePhonePoolLeaseRaw removePhoneNumberFromPhonePool removePhoneNumberFromPhonePoolRaw removePhoneNumberTags removePhoneNumberTagsRaw request searchAvailablePhoneNumbers searchAvailablePhoneNumbersRaw sendSmsFromPhoneNumber sendSmsFromPhoneNumberRaw setConsentStatus setConsentStatusRaw setPhoneFavourited setPhoneFavouritedRaw setPhoneNumberTags setPhoneNumberTagsRaw testPhoneNumberSendSms testPhoneNumberSendSmsRaw updatePhoneNumber updatePhoneNumberRaw updatePhonePool updatePhonePoolRaw validatePhoneNumber validatePhoneNumberRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

Properties

configuration: Configuration = ...

Methods

  • Create new phone number Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.

    Parameters

    Returns Promise<PhoneNumberDto>

  • Remove all phone number from account Delete all phone numbers

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<void>

  • Remove all phone number from account Delete all phone numbers

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<ApiResponse<void>>

  • Delete a phone pool and release any active leases from that pool Delete phone pool

    Parameters

    Returns Promise<void>

  • List phone pools for the authenticated user Get phone pools

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<PhonePoolDto[]>

  • List all unique tags used by your phone numbers Get phone tags

    Parameters

    Returns Promise<string[]>