Port-out Quickstart Guide
Background
When a carrier receives a port-in request they will send the current carrier a port-out notification to let them know that they wish to port-out a number, usually with the authorization of the end-user.
When Telnyx receives notice from another carrier for a port-out request, Telnyx will automatically create a port-out order in your account.
We typically ask that you respond to our port-out notification within 24 or 48 hours via email. If you do not wish for the numbers to be ported-out, it is important that you notify us as soon as possible in order to prevent the port-out from being processed. If you do not respond within that 24 or 48 hour window, we are required to authorize the port-out order.
Managing your port-out orders
Here is how you can approve or reject a port-out order.
First, you need to review that all of the information on the port-out order is correct.
If you received only an email notification, you can list all port-out orders to find the order you are looking for (identified by the support key). You can include a filter[status]=pending flag to narrow down the search results
Request:
curl --location -g --request GET 'https://api.telnyx.com/v2/portouts?filter[status]=pending' \
--header 'Authorization: Bearer [REDACTED]'
Response:
{
"data": [
{
"already_ported": false,
"authorized_name": null,
"carrier_name": "Telnyx",
"city": null,
"created_at": "2022-04-26T15:50:15+00:00",
"current_carrier": "telnyx",
"end_user_name": null,
"foc_date": null,
"id": "ab06d54a-bc1a-43b4-b448-82873f05fe32",
"inserted_at": "2022-04-26T15:50:15+00:00",
"lsr": [],
"phone_numbers": [
"{{e.164 phone number}}"
],
"pon": null,
"reason": null,
"record_type": "portout",
"requested_foc_date": "2022-04-29T00:00:00+00:00",
"service_address": null,
"spid": "073H",
"state": null,
"status": "pending",
"support_key": "PO_05fe32",
"updated_at": "2022-04-26T15:50:32+00:00",
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"vendor": null,
"zip": null
}
],
"meta": {
"page_number": 1,
"page_size": 20,
"total_pages": 1,
"total_results": 1
}
}
If you already know the port-out order ID, you can use the following endpoint to retrieve the order directly:
Request:
curl --location --request GET 'https://api.telnyx.com/v2/portouts/{{id}}' \
--header 'Authorization: Bearer [REDACTED]'
Response:
{
"data": {
"already_ported": false,
"authorized_name": null,
"carrier_name": "Telnyx",
"city": null,
"created_at": "2022-04-26T15:50:15+00:00",
"current_carrier": "telnyx",
"end_user_name": null,
"foc_date": null,
"id": "ab06d54a-bc1a-43b4-b448-82873f05fe32",
"inserted_at": "2022-04-26T15:50:15+00:00",
"lsr": [],
"phone_numbers": [
"{{e.164 phone number}}"
],
"pon": null,
"reason": null,
"record_type": "portout",
"requested_foc_date": "2022-04-29T00:00:00+00:00",
"service_address": null,
"spid": "073H",
"state": null,
"status": "pending",
"support_key": "PO_05fe32",
"updated_at": "2022-04-26T15:50:32+00:00",
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"vendor": null,
"zip": null
}
}
After reviewing the port-out order, you need to either authorize or reject the port-out.
To authorize the port-out, make the following command (where {id} is the port-out order ID)
Request:
curl --location --request PATCH 'https://api.telnyx.com/v2/portouts/{{id}}/authorized' \
--header 'Authorization: Bearer [REDACTED]'
Response:
{
"data": {
"already_ported": false,
"authorized_name": null,
"carrier_name": "Telnyx",
"city": null,
"created_at": "2022-04-26T15:50:15+00:00",
"current_carrier": "telnyx",
"end_user_name": null,
"foc_date": "2022-04-29T00:00:00+00:00",
"id": "ab06d54a-bc1a-43b4-b448-82873f05fe32",
"inserted_at": "2022-04-26T15:50:15+00:00",
"lsr": [],
"phone_numbers": [
"{{e.164 phone number}}"
],
"pon": null,
"reason": null,
"record_type": "portout",
"requested_foc_date": "2022-04-29T00:00:00+00:00",
"service_address": null,
"spid": "073H",
"state": null,
"status": "authorized",
"support_key": "PO_05fe32",
"updated_at": "2022-04-26T17:38:33+00:00",
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"vendor": null,
"zip": null
}
}
To reject the port-out, make the following command. Please ensure that you give a reason for rejection in the body of the request.
Request:
curl --location --request PATCH 'https://api.telnyx.com/v2/portouts/ab06d54a-bc1a-43b4-b448-82873f05fe32/rejected-pending' \
--header 'Authorization: Bearer [REDACTED]' \
--header 'Content-Type: application/json' \
--data-raw '{
"reason":"{{this is why I am rejecting the port-out request}}"
}'
Response:
{
"data": {
"already_ported": false,
"authorized_name": null,
"carrier_name": "Telnyx",
"city": null,
"created_at": "2022-04-26T15:50:15+00:00",
"current_carrier": "telnyx",
"end_user_name": null,
"foc_date": null,
"id": "ab06d54a-bc1a-43b4-b448-82873f05fe32",
"inserted_at": "2022-04-26T15:50:15+00:00",
"lsr": [],
"phone_numbers": [
"{{e.164 phone number}}"
],
"pon": null,
"reason": "this is why I am rejecting the port-out request",
"record_type": "portout",
"requested_foc_date": "2022-04-29T00:00:00+00:00",
"service_address": null,
"spid": "073H",
"state": null,
"status": "rejected-pending",
"support_key": "PO_05fe32",
"updated_at": "2022-04-26T17:36:24+00:00",
"user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
"vendor": null,
"zip": null
}
}
If authorized, Porting Ops will port the order on the scheduled FOC date
If rejected, Porting Ops will review the reasoning to determine whether the port-out Order needs to be updated, or whether the port-out order can be canceled
If the port-out request is neither approved or rejected within 48 hours it will automatically receive FOC for the requested porting date.