Skip to content
English - Canada
  • There are no suggestions because the search field is empty.

Port-In Requests

Target Service

All port-in requests must be ported in as a new service, or as an additional telephone number for an existing service. We cannot port in telephone numbers by themselves without an associated target service. Each product type has a unique port-in operation to handle product specific fields, rather than a single complex endpoint that models every possible product.

Existing Service

Currently, the only type of products that allows additional telephone numbers are our SIP Trunking products. Additional telephone numbers can be added as DID (Direct Inward Dialing) numbers. A list of existing SIP Trunks for your account can be found using the following operation.

GET /SipTrunks

Once the pilot number of the target SIP Trunk is known, the operation for submitting DID port-in requests further depends on whether the telephone number being ported is a toll-free telephone number or not. Regular telephone numbers and toll-free telephone numbers cannot be combined together into a single port-in request.

Type Port-In Request Operation
Regular telephone number 
POST /v2/NumberPorts/Inbound/DIDs
Toll-free telephone number 
POST /v2/NumberPorts/Inbound/TollFree/DIDs

Each operation has their own product specific fields required. Further information about specific operations can be found within our Swagger UI.

New Service

A list of available product offerings for your account that are suitable for port-in requests can be found using the following operation.

GET /Products/TelephoneOfferings

The key pieces of information you will need is the OfferingID and Type fields. The product Type field determines which port-in request operation you should use for it. And the OfferingID field is required to unique identify which product offering to use for the new service.

Product Type
Name		 Product Type
Value		 Port-In Request Operation
General Product 1 
POST /NumberPorts/Inbound/GeneralProducts
General Child Product 2 
POST /NumberPorts/Inbound/GeneralChildProducts
Residential Line 3 
POST /v2/NumberPorts/Inbound/ResidentialLines
Business Line 4 
POST /v2/NumberPorts/Inbound/BusinessLines
Permanent Call Forward 5 
POST /v2/NumberPorts/Inbound/PermanentCallForwards
OR
POST /v2/NumberPorts/Inbound/TollFree/PermanentCallForwards
Business Permanent Call Forward 6 
POST /NumberPorts/Inbound/BusinessPermanentCallForwards
Virtual Fax 7 
POST /NumberPorts/Inbound/VirtualFaxes

Each operation has their own product specific fields required. Further information about specific operations can be found within our Swagger UI.

Common Fields

All port-in request operations require a PortForm object which encapsulates the common fields for port-in requests.  Descriptions of the fields can be found within our Swagger UI.