ALalianza
Telephone Number

Telephone number search

Use to search for a telephone number. <span hidden>Refer to <a href="tnInventory.html#search-tn">Search Partition for Telephone Number</a> for more information.</span>

get/v2/partition/{partitionId}/telephonenumber/search

Request

Path parameters

partitionIdstring required

ID of partition, reference to <a href="#/~schema/Account">account.partitionId</a>

Query parameters

carrierIdstring

<a href="#/~schema/InboundCarrierX">inboundCarrierX.id</a>

functiontype'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN'

Function Type, default ELS

latnumber double

Latitude, requires type=LAT_LONG

longnumber double

Latitude, requires type=LAT_LONG

maxResultsinteger

Number of results to return

qstring

Query Field: q=18015551212, q=84062, q=ALBANY, q=ALBANY.NY, LAT_LONG does not use this field

type'POSTALCODE_OR_TN' | 'TN' | 'POSTALCODE' | 'LAT_LONG' | 'RATECENTER' | 'RATECENTER_CARRIER'

Search Type, default POSTALCODE_OR_TN

Response

Successful operation

partitionIdstring
phoneNumberstring
rateCenterstring
rateCenterReorderNamestring
statestring
countrystring
prefixstring
accountIdstring
carrierIdstring

The <a href="#/~schema/InboundCarrierX">inboundCarrierX.id</a> that services the telephone number.

cooldownExpireDatestring date-time
cooldownRecoveredDatestring date-time
functionType'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN'
claimTicketIdstring
matchesZipboolean

When this object is returned as part of a <a href="#/~operation/Telephone%20Number/tnSearch">search</a> that uses a zip code, results for nearby zip codes are also returned. This field indicates if the returned data matches the queried zip code.

distancenumber float

When this object is returned as part of a <a href="#/~operation/Telephone%20Number/tnSearch">search</a> that uses a zip code, results for nearby zip codes are also returned. This field represents the distance (in miles) from the specified zip code.

byotnboolean

Bring Your Own Telephone Number (byotn) is a feature that allows the service provider to manage the rate center footprint coverage for a number.

activationDateinteger
isInInventoryboolean
operationalStatus'ACTIVE' | 'STAGED'
idstring
portboolean
tagsstring[]

Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number.

Changes

No recorded changes to this operation across all 1 revision of this API.