Skip to main content

Retrieve a porting activation job

GET 
/porting_orders/:id/activation_jobs/:activationJobId

Returns a porting activation job.

Request​

Path Parameters

    id uuidrequired

    Porting Order id

    activationJobId uuidrequired

    Activation Job Identifier

Responses​

200: Successful response

Schema

    data

    object

    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.

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/:activationJobId' \
-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"
  }
}