Create a porting related report

Generate reports about porting operations.

POST /porting/reports

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const report = await client.porting.reports.create({
  params: { filters: {} },
  report_type: 'export_porting_orders_csv',
});

console.log(report.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
report = client.porting.reports.create(
    params={
        "filters": {}
    },
    report_type="export_porting_orders_csv",
)
print(report.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	report, err := client.Porting.Reports.New(context.TODO(), telnyx.PortingReportNewParams{
		Params: telnyx.ExportPortingOrdersCsvReportParam{
			Filters: telnyx.ExportPortingOrdersCsvReportFiltersParam{},
		},
		ReportType: telnyx.PortingReportNewParamsReportTypeExportPortingOrdersCsv,
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", report.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.porting.reports.ExportPortingOrdersCsvReport;
import com.telnyx.sdk.models.porting.reports.ReportCreateParams;
import com.telnyx.sdk.models.porting.reports.ReportCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ReportCreateParams params = ReportCreateParams.builder()
            .params(ExportPortingOrdersCsvReport.builder()
                .filters(ExportPortingOrdersCsvReport.Filters.builder().build())
                .build())
            .reportType(ReportCreateParams.ReportType.EXPORT_PORTING_ORDERS_CSV)
            .build();
        ReportCreateResponse report = client.porting().reports().create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

report = telnyx.porting.reports.create(params: {filters: {}}, report_type: :export_porting_orders_csv)

puts(report)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $report = $client->porting->reports->create(
    params: [
      'filters' => [
        'createdAtGt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
        'createdAtLt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
        'customerReferenceIn' => ['my-customer-reference'],
        'statusIn' => ['draft'],
      ],
    ],
    reportType: 'export_porting_orders_csv',
  );

  var_dump($report);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx porting:reports create \
  --api-key 'My API Key' \
  --params '{filters: {}}' \
  --report-type export_porting_orders_csv

curl --request POST \
  --url https://api.telnyx.com/v2/porting/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_type": "export_porting_orders_csv",
  "params": {
    "filters": {
      "status__in": [],
      "customer_reference__in": [
        "my-customer-reference"
      ],
      "created_at__lt": "2023-11-07T05:31:56Z",
      "created_at__gt": "2023-11-07T05:31:56Z"
    }
  }
}
'

201

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "report_type": "export_porting_orders_csv",
    "status": "completed",
    "params": {
      "filters": {
        "status__in": [],
        "customer_reference__in": [
          "my-customer-reference"
        ],
        "created_at__lt": "2023-11-07T05:31:56Z",
        "created_at__gt": "2023-11-07T05:31:56Z"
      }
    },
    "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "record_type": "porting_report",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The parameters for generating a new porting related report.

report_type · enum<string> · required

Identifies the type of report

Available options: export_porting_orders_csv

Example:

"export_porting_orders_csv"

params · object · required

The parameters for generating a porting orders CSV report.

Show child attributes

Response

201

application/json

Successful response

data · object

Show child attributes