Skip to main content

List all porting activation jobs

GET 
/porting_orders/:id/activation_jobs

Returns a list of your porting activation jobs.

Request ​

Path Parameters

    id uuidrequired

    Porting Order id

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this activation job

    status string

    Possible values: [created, in-process, completed, failed]

    Specifies the status of this activation job

    activation_type string

    Possible values: [scheduled, on-demand]

    Specifies the type of this activation job

    activate_at date-time

    ISO 8601 formatted date indicating when the activation job should be executed. This time should be between some activation window.

    activation_windows

    object[]

    List of allowed activation windows for this activation job

  • Array [

    • start_at date-time

    ISO 8601 formatted date indicating when the activation window starts

    end_at date-time

    ISO 8601 formatted date indicating when the activation window ends

  • ]

    • List of allowed activation windows for this activation job

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was created.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/v2/porting_orders/:id/activation_jobs' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "status": "created",
      "activation_type": "scheduled",
      "activate_at": "2021-03-19T10:07:15.527Z",
      "activation_windows": [
        {
          "start_at": "2021-03-19T10:07:15.527Z",
          "end_at": "2021-03-19T10:07:15.527Z"
        }
      ],
      "record_type": "porting_activation_job",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}