List all porting orders
GET/porting_orders
Returns a list of your porting order.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Default value: true
Include the first 50 phone number objects in the results
Possible values: [draft
, in-process
, submitted
, exception
, foc-date-confirmed
, cancel-pending
, ported
, cancelled
]
Filter results by status
Possible values: [draft
, in-process
, submitted
, exception
, foc-date-confirmed
, cancel-pending
, ported
, cancelled
]
Filter porting orders by multiple statuses
Filter results by customer_reference
Filter results by parent_support_key
Filter results by country ISO 3166-1 alpha-2 code
Filter results by old service provider
Possible values: [full
, partial
]
Filter results by porting order type
Filter results by person or company name
Filter results by authorized person
Filter results by fast port eligible
Filter results by foc date later than this value
Filter results by foc date earlier than this value
Filter results by full or partial phone_number
Possible values: [created_at
, -created_at
, activation_settings.foc_datetime_requested
, -activation_settings.foc_datetime_requested
]
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
data
object[]
Uniquely identifies this porting order
A customer-specified reference number for customer bookkeeping purposes
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was created.
status
object
Porting order status
details
object[]
A list of 0 or more details about this porting order's status
Possible values: [ACCOUNT_NUMBER_MISMATCH
, AUTH_PERSON_MISMATCH
, BTN_ATN_MISMATCH
, ENTITY_NAME_MISMATCH
, FOC_EXPIRED
, FOC_REJECTED
, LOCATION_MISMATCH
, LSR_PENDING
, MAIN_BTN_PORTING
, OSP_IRRESPONSIVE
, OTHER
, PASSCODE_PIN_INVALID
, PHONE_NUMBER_HAS_SPECIAL_FEATURE
, PHONE_NUMBER_MISMATCH
, PHONE_NUMBER_NOT_PORTABLE
, PORT_TYPE_INCORRECT
, PORTING_ORDER_SPLIT_REQUIRED
, PORTING_ORDER_SPLIT_REQUIRED
, POSTAL_CODE_MISMATCH
, RATE_CENTER_NOT_PORTABLE
, SV_CONFLICT
, SV_UNKNOWN_FAILURE
]
Identifier of an exception type
Description of an exception type
Possible values: [draft
, in-process
, submitted
, exception
, foc-date-confirmed
, ported
, canceled
, cancel-pending
]
The current status of the porting order
A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders.
A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in draft
state
Count of phone numbers associated with this porting order
Identifies the old service provider
documents
object
Returned ID of the submitted LOA via the Documents endpoint
Returned ID of the submitted Invoice via the Documents endpoint
misc
object
Possible values: [full
, partial
]
A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.
Possible values: [keep
, disconnect
]
Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.
New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.
end_user
object
admin
object
Person Name or Company name requesting the port
Name of person authorizing the porting order
Billing phone number associated with these phone numbers
The authorized person's account number with the current service provider
European tax identification number. Applicable only in the European Union
PIN/passcode possibly required by the old service provider for extra verification
European business identification number. Applicable only in the European Union
location
object
First line of billing address
Second line of billing address
City or municipality of billing address
State, province, or similar of billing address
Postal Code of billing address
ISO3166-1 alpha-2 country code of billing address
activation_settings
object
ISO 8601 formatted Date/Time requested for the FOC date
ISO 8601 formatted Date/Time of the FOC date
Indicates whether this porting order is eligible for FastPort
Possible values: [New
, Pending
, Conflict
, Cancel Pending
, Failed
, Concurred
, Activate RDY
, Disconnect Pending
, Concurrence Sent
, Old
, Sending
, Active
, Canceled
]
Activation status
phone_number_configuration
object
identifies the billing group to set on the numbers when ported
identifies the connection to set on the numbers when ported
identifies the messaging profile to set on the numbers when ported
identifies the emergency address to set on the numbers when ported
Possible values: [landline
, local
, mobile
, national
, shared_cost
, toll_free
]
The type of the phone number
A description of the porting order
requirements
object[]
List of documentation requirements for porting numbers.
Possible values: [document
]
Type of value expected on field_value field
identifies the document that satisfies this requirement
Identifies the requirement type that meets this requirement
Identifies the type of the resource.
Is true when the required documentation is met
user_feedback
object
Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience
A comment related to the customer rating.
Identifies the user (or organization) who requested the porting order
Identifies the type of the resource.
meta
object
{
"data": [
{
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"customer_reference": "Acct 123abc",
"created_at": "2021-03-19T10:07:15.527Z",
"updated_at": "2021-03-19T10:07:15.527Z",
"status": {
"details": [
{
"code": "ENTITY_NAME_MISMATCH",
"description": "Entity name does not match that on the CSR"
}
],
"value": "ported"
},
"support_key": "sr_123abc",
"parent_support_key": "pr_123abc",
"porting_phone_numbers_count": 1,
"old_service_provider_ocn": "Unreal Communications",
"documents": {
"loa": "64ffb720-04c7-455b-92d6-20fcca92e935",
"invoice": "ce74b771-d23d-4960-81ec-8741b3862146"
},
"misc": {
"type": "full",
"remaining_numbers_action": "disconnect",
"new_billing_phone_number": "string"
},
"end_user": {
"admin": {
"entity_name": "Porter McPortersen",
"auth_person_name": "Porter McPortersen II",
"billing_phone_number": 13035551234,
"account_number": "123abc",
"tax_identifier": "1234abcd",
"pin_passcode": 1234,
"business_identifier": "abc123"
},
"location": {
"street_address": "311 W. Superior St",
"extended_address": "Suite 504",
"locality": "Chicago",
"administrative_area": "IL",
"postal_code": "60654",
"country_code": "US"
}
},
"activation_settings": {
"foc_datetime_requested": "2021-03-19T10:07:15.527Z",
"foc_datetime_actual": "2021-03-19T10:07:15.527Z",
"fast_port_eligible": true,
"activation_status": "Active"
},
"phone_number_configuration": {
"billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
"connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
"messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
"emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
"tags": [
"abc",
"123"
]
},
"phone_number_type": "local",
"description": "FP Telnyx",
"requirements": [
{
"field_type": "document",
"field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
"requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66",
"record_type": "porting_requirement"
}
],
"requirements_met": false,
"user_feedback": {
"user_rating": 5,
"user_comment": "I loved my experience porting numbers with Telnyx"
},
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"webhook_url": "https://example.com/porting_webhooks",
"record_type": "porting_order"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
401: Unauthorized
422: Unprocessable entity. Check message field in response for details.