Private Beta Notice
The Port Orders API endpoints are currently in Private Beta. Some features may change as we receive and incorporate your feedback. To get invited and start testing the beta version, please send an email to firstname.lastname@example.org.
Use this endpoint to check if a particular number can be ported by Flowroute before creating a port order.
Additionally, toll-free and local numbers are managed by different network databases. As a result, local numbers will always be placed in a separate port order from toll-free numbers. In cases where phone numbers have been resold from various underlying carriers, Flowroute will split the port order based on the underlying carrier responsible for the porting numbers.
Contains fields related to numbers that can be ported to Flowroute.
numbersarray containing strings
Contains numbers that the user posted to the endpoint. If nested under the portable field, these numbers can be ported to Flowroute. If nested under the nonportable field, these numbers can not be ported to Flowroute.
groupsarray containing hashes
Contains objects for groupings of portable numbers. This object is designed to guide you in creating your port orders in such a way that will not require splitting up the order later. See guide on Port Order splitting.
Name of the carrier that is currently providing service for the associated numbers.
Unique carrier identifier for the Current Service Provider.
Name of the carrier that will take over service for the associated porting numbers. This will always be Flowroute or one of our peering carriers.
Unique carrier identifier for the Gaining Service Provider
Identifies whether the numbers associated with the group are long-code (landline), toll-free, or wireless. This is relevant as Port Orders can only contain numbers of the same type. Learn more about port order splitting here.
Local Access and Transport Area that the associated numbers reside in. This only relates to long-code and wireless numbers.
Contains fields related to numbers that can not be ported to Flowroute