Skip to main content

Create a port-out related report

POST 
/portout/reports

Generate reports about port-out operations.

Request ​

Body

required

    report_type stringrequired

    Possible values: [export_portouts_csv]

    Identifies the type of report

    params

    object

    required

    oneOf

    The parameters for generating a port-outs CSV report.

    filters

    object

    required

    The filters to apply to the export port-out CSV report.

    status__in string[]

    Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

    The status of the port-outs to include in the report.

    customer_reference__in string[]

    The customer reference of the port-outs to include in the report.

    end_user_name string

    The end user name of the port-outs to include in the report.

    phone_numbers__overlaps string[]

    A list of phone numbers that the port-outs phone numbers must overlap with.

    created_at__lt date-time

    The date and time the port-out was created before.

    created_at__gt date-time

    The date and time the port-out was created after.

    The filters to apply to the export port-out CSV report.

Responses ​

201: Successful response

Schema

    data

    object

    id uuid

    Uniquely identifies the report.

    report_type string

    Possible values: [export_portouts_csv]

    Identifies the type of report

    status string

    Possible values: [pending, completed]

    The current status of the report generation.

    params

    object

    oneOf

    The parameters for generating a port-outs CSV report.

    filters

    object

    required

    The filters to apply to the export port-out CSV report.

    status__in string[]

    Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

    The status of the port-outs to include in the report.

    customer_reference__in string[]

    The customer reference of the port-outs to include in the report.

    end_user_name string

    The end user name of the port-outs to include in the report.

    phone_numbers__overlaps string[]

    A list of phone numbers that the port-outs phone numbers must overlap with.

    created_at__lt date-time

    The date and time the port-out was created before.

    created_at__gt date-time

    The date and time the port-out was created after.

    The filters to apply to the export port-out CSV report.

    document_id uuid

    Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.

    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 updated.

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

500: Internal server error

Request samples

curl -L 'https://api.telnyx.com/v2/portout/reports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "report_type": "export_portouts_csv",
  "params": {
    "filters": {
      "status__in": [
        "pending"
      ],
      "customer_reference__in": [
        "my-customer-reference"
      ],
      "end_user_name": "McPortersen",
      "phone_numbers__overlaps": [
        "+1234567890"
      ],
      "created_at__lt": "2024-07-29T15:51:28.071Z",
      "created_at__gt": "2024-07-29T15:51:28.071Z"
    }
  }
}'

Response samples

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "report_type": "export_portouts_csv",
    "status": "completed",
    "params": {},
    "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "record_type": "portout_report",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}