Port

Get port data

Retrieve the information of a previously submitted port. In order to retrieve the port record, you need to know the partition, account, and id fields of the port. The port id will have been return when you submitted the port you now wish to query.

get/v2/partition/{partitionId}/account/{accountId}/port/{portId}

Request

Path parameters

accountIdstring required

ID of account. Reference to <a href="#/~schema/Account">account.id</a> via <a href="#/~schema/PortX">port.accountId</a>

partitionIdstring required

ID of partition. Reference to <a href="#/~schema/PartitionX">partition.id</a> via <a href="#/~schema/PortX">port.partitionId</a>

portIdstring required

Reference to <a href="#/~schema/PortX">port.id</a>

Response

Successful operation

idstring
partitionIdstring
accountIdstring
telephoneNumbersstring[]
status'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED'
sendLoaboolean
loaSavedboolean
carrierIdstring
carrierType'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER'
crdDatestring date-time
billingTelephoneNumberstring
portingWireType'Wireless' | 'Wireline'
portingAuthorizedNamestring
wirelessAccountNumberstring
wirelessPinstring
focDatestring date-time
focDateTimeZone'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland'
createdDatestring date-time
completedDatestring date-time
cancelType'NORMAL' | 'EXPIDITED' | 'BY_CARRIER'
hotCutPortIdstring
portNowboolean
canAcceptSMSboolean
smsCallbackUrlstring
tagsstring[]

Changes

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