Telephone Number

Create telephone number in inventory

Use to add a telephoneNumber to the specified partition's inventory.

post/v2/partition/{partitionId}/telephonenumber

Request

Base URL
https://api.alianza.com
Auth
API key in header X-AUTH-TOKEN
TypeScript
https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/telephonenumber/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

Request body

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.

Response

Successful operation