import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const report = await client.portouts.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(report.data);{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_portouts_csv",
"status": "completed",
"params": {
"filters": {
"status__in": [
"pending"
],
"customer_reference__in": [
"my-customer-reference"
],
"end_user_name": "McPortersen",
"phone_numbers__overlaps": [
"+1234567890"
],
"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": "portout_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.portouts.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(report.data);{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_portouts_csv",
"status": "completed",
"params": {
"filters": {
"status__in": [
"pending"
],
"customer_reference__in": [
"my-customer-reference"
],
"end_user_name": "McPortersen",
"phone_numbers__overlaps": [
"+1234567890"
],
"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": "portout_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_portouts_csv "export_portouts_csv"
The current status of the report generation.
pending, completed "completed"
The parameters for generating a port-outs CSV report.
Show child attributes
The filters to apply to the export port-out CSV report.
Show child attributes
The status of the port-outs to include in the report.
pending, authorized, ported, rejected, rejected-pending, canceled The customer reference of the port-outs to include in the report.
The end user name of the port-outs to include in the report.
"McPortersen"
A list of phone numbers that the port-outs phone numbers must overlap with.
The date and time the port-out was created before.
The date and time the port-out 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.
"portout_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?