Porting Orders
Retrieve a porting order
Retrieves the details of an existing porting order.
get/porting_orders/{id}
Path parameters
idstring uuid required
Porting Order id
Query parameters
include_phone_numbersboolean
Include the first 50 phone number objects in the results
Response
Successful response
Example response
{
"data": {
"activation_settings": {
"activation_status": "Active",
"fast_port_eligible": true,
"foc_datetime_actual": "2021-03-19T10:07:15.527Z",
"foc_datetime_requested": "2021-03-19T10:07:15.527Z"
},
"created_at": "2021-03-19T10:07:15.527Z",
"customer_group_reference": "Group-456",
"customer_reference": "Acct 123abc",
"description": "FP Telnyx",
"documents": {
"invoice": "ce74b771-d23d-4960-81ec-8741b3862146",
"loa": "64ffb720-04c7-455b-92d6-20fcca92e935"
},
"end_user": {
"admin": {
"account_number": "123abc",
"auth_person_name": "Porter McPortersen II",
"billing_phone_number": "13035551234",
"business_identifier": "abc123",
"entity_name": "Porter McPortersen",
"pin_passcode": "1234",
"tax_identifier": "1234abcd"
},
"location": {
"administrative_area": "TX",
"country_code": "US",
"extended_address": "14th Floor",
"locality": "Austin",
"postal_code": "78701",
"street_address": "600 Congress Avenue"
}
},
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"messaging": {
"enable_messaging": true,
"messaging_capable": true,
"messaging_port_status": "pending"
},
"misc": {
"remaining_numbers_action": "disconnect",
"type": "full"
},
"old_service_provider_ocn": "Unreal Communications",
"parent_support_key": "pr_123abc",
"phone_number_configuration": {
"billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
"connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
"emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
"messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
"tags": [
"abc",
"123"
]
},
"phone_number_type": "local",
"phone_numbers": [
{
"activation_status": "Active",
"phone_number": "13035550987",
"phone_number_type": "local",
"portability_status": "confirmed",
"porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
"porting_order_status": "in-process",
"record_type": "porting_phone_number",
"requirements_status": "approved",
"support_key": "sr_a12345"
}
],
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"requirements": [
{
"field_type": "document",
"field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
"record_type": "porting_requirement",
"requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
}
],
"status": {
"details": [
{
"code": "ENTITY_NAME_MISMATCH",
"description": "Entity name does not match that on the CSR"
}
],
"value": "ported"
},
"support_key": "sr_123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_feedback": {
"user_comment": "I loved my experience porting numbers with Telnyx",
"user_rating": 5
},
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222"
}
}