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

Responses

201: Successful response

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-24T16:24:39.395Z",
"created_at__gt": "2024-07-24T16:24:39.395Z"
}
}
}'

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"
}
}