FastPort - On Demand Activations

By default, activations are scheduled to occur on the actual FOC date/time assigned to an order. However, if an order is FastPort eligible, then you have the option to enable and perform an on-demand activation. With on-demand activations, you will have the ability and flexibility to port your phone numbers at your convenience.

When the FOC date arrives, you'll have a designated window of time to initiate the porting order activation. This window varies based on the country of origin of the phone numbers you're porting in. If you forget or fail to activate the order, then the order will automatically be ported at the conclusion of the window.

If an order is "fast_port_eligible": true, then it is eligible for on-demand activation. However, by default all orders are configured for scheduled activations (“activation_type”: “scheduled”). To change the activation type and enable on-demand activation for the porting order, you can make the following request:

Note

Don't forget to update YOUR_API_KEY here.

curl --location --request PATCH 'https://api.telnyx.com/v2/porting_orders/{id}' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "activation_settings": {
        "activation_type": "on-demand"
    }
}'

{
   "data":[
      {
         "activation_settings":{
            "activation_status": null,
            "activation_type": "on-demand",
            "fast_port_eligible": true,
            "foc_datetime_actual": null,
            "foc_datetime_requested": null
         },
 …
      }

Once your order transitions into a “foc-date-confirmed” status, an activation job will be created. You can view that job by performing the following request:

Request:

curl --location --request GET 'https://api.telnyx.com/v2/porting_orders/{{porting_order_id}}/activation_jobs' \
--header 'Authorization: Bearer [REDACTED]'

Response:

{
    "data": [
        {
            "activate_at": "2023-10-14T01:00:00Z",
            "activation_type": "on-demand",
            "activation_windows": [
                {
                    "end_at": "2023-10-14T01:00:00Z",
                    "start_at": "2023-10-13T11:00:00Z"
                }
            ],
            "created_at": "2023-10-09T16:09:36Z",
            "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
            "record_type": "porting_activation_job",
            "status": "created",
            "updated_at": "2023-10-09T16:09:36Z"
        }
    ],
    "meta": {
        "page_number": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_results": 1
    }
}

In the response, the activation_windows array will indicate the allowable time period to activate the port order. So in the example above, you would be able to activate your order anytime between 10/13/2023 11:00:00Z and 10/14/2023 01:00:00Z.

We are currently offering FastPort on-demand activation in 2 countries: US and Canada. These countries have the following activation windows:

• US is a 14 hour window, starting at 6:00 AM CT and ending at 8:00 PM CT on the FOC date
• CA is a 7 hour window, starting at 8:00 AM CT and ending at 3:00 PM CT on the FOC date

The "activate_at" attribute indicates the date and time when the order will port. By default, the "activate_at" field corresponds to the end of the specified activation window. Therefore, if you forget to activate your order, it will still automatically port at the end of the window. Upon triggering the on-demand activation, the "activate_at" attribute will update to reflect the date and time of your request, thus immediately initiating the port order activation.

When the FOC date arrives, you can initiate the activation job to start porting your numbers by executing the following command:

Request:

curl --location --request POST 'https://api.telnyx.com/v2/porting_orders/{{porting_order_id}}/actions/activate' \
--header 'Authorization: Bearer [REDACTED]'

Response:

{
   "data":{
      "activate_at": "2023-10-13T15:43:00Z",
      "activation_type": "on-demand",
      "activation_windows":[
         {
            "end_at": "2023-10-14T01:00:00Z",
            "start_at": "2023-10-13T11:00:00Z"
         }
      ],
      "created_at": "2023-10-09T16:09:36Z",
      "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
      "record_type": "porting_activation_job",
      "status": "created",
      "updated_at": "2023-10-09T16:09:36Z"
   }
}

By submitting that request, the "activate_at" attribute is updated to reflect the date and time you initiated the request. It may take a few minutes for the activation to occur and your order to port. You can check on the status of your activation job in 2 ways.

You can retrieve a specific activation job, using the following endpoint:

Request:
curl --location --request GET 'https://api.telnyx.com/v2/porting_orders/{{porting_order_id}}/activation_jobs/{activation_job_id}' \
--header 'Authorization: Bearer [REDACTED]'

Response:
{
   "data":{
      "activate_at": "2023-10-13T15:43:00Z",
      "activation_type": "on-demand",
      "activation_windows":[
         {
            "end_at": "2023-10-14T01:00:00Z",
            "start_at": "2023-10-13T11:00:00Z"
         }
      ],
      "created_at": "2023-10-09T16:09:36Z",
      "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
      "record_type": "porting_activation_job",
      "status": "created",
      "updated_at": "2023-10-09T16:09:36Z"
   }
}

Or you can list all activation jobs for a port order using the following command:

Request:
curl --location --request GET 'https://api.telnyx.com/v2/porting_orders/{{porting_order_id}}/activation_jobs' \
--header 'Authorization: Bearer [REDACTED]'

Response:
{
   "data":[
      {
         "activate_at": "2023-10-13T15:43:00Z",
         "activation_type": "on-demand",
         "activation_windows":[
            {
               "end_at": "2023-10-14T01:00:00Z",
               "start_at": "2023-10-13T11:00:00Z"
            }
         ],
         "created_at": "2023-10-09T16:09:36Z",
         "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
         "record_type": "porting_activation_job",
         "status": "created",
         "updated_at": "2023-10-09T16:09:36Z"
      }
   ],
   "meta":{
      "page_number": 1,
      "page_size": 20,
      "total_pages": 1,
      "total_results": 1
   }
}

After a few minutes, the activation job will transition into an in-process status.

Request:
curl --location --request GET 'https://api.telnyx.com/v2/porting_orders/1d19d2b3-b6df-458c-9594-31564c44912a/activation_jobs' \
--header 'Authorization: Bearer [REDACTED]'


Response:
{
    "data": [
      {
         "activate_at": "2023-10-13T15:43:00Z",
         "activation_type": "on-demand",
         "activation_windows":[
            {
               "end_at": "2023-10-14T01:00:00Z",
               "start_at": "2023-10-13T11:00:00Z"
            }
         ],
         "created_at": "2023-10-09T16:09:36Z",
         "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
         "record_type": "porting_activation_job",
         "status": "in-process",
         "updated_at": "2023-10-09T16:09:36Z"
      }
    ],
    "meta": {
        "page_number": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_results": 1
    }
}

Finally, once the phone numbers finish activating, the job will transition into a completed status. This may take a few more minutes. Once the job has transitioned into a completed status, your porting order is complete and the phone numbers have finished porting!

Request:
curl --location --request GET 'https://api.telnyx.com/v2/porting_orders/1d19d2b3-b6df-458c-9594-31564c44912a/activation_jobs' \
--header 'Authorization: Bearer [REDACTED]'


Response:
{
   "data":[
      {
         "activate_at": "2023-10-13T15:43:00Z",
         "activation_type": "on-demand",
         "activation_windows":[
            {
               "end_at": "2023-10-14T01:00:00Z",
               "start_at": "2023-10-13T11:00:00Z"
            }
         ],
         "created_at": "2023-10-09T16:09:36Z",
         "id": "d10b42f7-540c-4ed0-91eb-ce774f43dbb8",
         "record_type": "porting_activation_job",
         "status": "completed",
         "updated_at": "2023-10-09T16:09:36Z"
      }
   ],
   "meta":{
      "page_number": 1,
      "page_size": 20,
      "total_pages": 1,
      "total_results": 1
   }
}