import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const report = await client.porting.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(report.data);{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_porting_orders_csv",
"status": "completed",
"params": {
"filters": {
"status__in": [
"draft"
],
"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"
}
}Retrieve a specific report generated.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const report = await client.porting.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(report.data);{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_porting_orders_csv",
"status": "completed",
"params": {
"filters": {
"status__in": [
"draft"
],
"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"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Identifies a report.
Successful response
Show child attributes
Uniquely identifies the report.
"eef3340b-8903-4466-b445-89b697315a3a"
Identifies the type of report
export_porting_orders_csv "export_porting_orders_csv"
The current status of the report generation.
pending, completed "completed"
The parameters for generating a porting orders CSV report.
Show child attributes
The filters to apply to the export porting order CSV report.
Show child attributes
The status of the porting orders to include in the report.
draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled The customer reference of the porting orders to include in the report.
The date and time the porting order was created before.
The date and time the porting order was created after.
Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.
"f1486bae-f067-460c-ad43-73a92848f902"
Identifies the type of the resource.
"porting_report"
ISO 8601 formatted date indicating when the resource was created.
"2021-03-19T10:07:15.527000Z"
ISO 8601 formatted date indicating when the resource was updated.
"2021-03-19T10:07:15.527000Z"
Was this page helpful?