Back to Details

telnyx-account-reports-curl

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 从Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Account Reports - curl

Telnyx账户报告 - curl

Installation

安装

text
undefined
text
undefined

curl is pre-installed on macOS, Linux, and Windows 10+

curl is pre-installed on macOS, Linux, and Windows 10+

undefined
undefined

Setup

配置

bash
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
All examples below use 
$TELNYX_API_KEY
for authentication.
bash
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
以下所有示例均使用
$TELNYX_API_KEY
进行身份验证。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
bash
undefined
所有API调用都可能因网络错误、速率限制(429)、校验错误(422)或身份验证错误(401)而失败。在生产代码中请始终处理错误：
bash
undefined

Check HTTP status code in response

Check HTTP status code in response

response=$(curl -s -w "\n%{http_code}"
-X POST "https://api.telnyx.com/v2/messages"
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')
http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')
case $http_code in 2*) echo "Success: $body" ;; 422) echo "Validation error — check required fields and formats" ;; 429) echo "Rate limited — retry after delay"; sleep 1 ;; 401) echo "Authentication failed — check TELNYX_API_KEY" ;; *) echo "Error $http_code: $body" ;; esac

Common error codes: `401` invalid API key, `403` insufficient permissions,
`404` resource not found, `422` validation error (check field formats),
`429` rate limited (retry with exponential backoff).
response=$(curl -s -w "\n%{http_code}"
-X POST "https://api.telnyx.com/v2/messages"
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')
http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')
case $http_code in 2*) echo "Success: $body" ;; 422) echo "Validation error — check required fields and formats" ;; 429) echo "Rate limited — retry after delay"; sleep 1 ;; 401) echo "Authentication failed — check TELNYX_API_KEY" ;; *) echo "Error $http_code: $body" ;; esac

常见错误码：`401` API密钥无效，`403` 权限不足，`404` 资源未找到，`422` 校验错误（请检查字段格式），`429` 触发速率限制（请使用指数退避重试）。

Important Notes

重要提示

  • Pagination: List endpoints return paginated results. Use 
    page[number]
    and 
    page[size]
    query parameters to navigate pages. Check 
    meta.total_pages
    in the response.
  • 分页： 列表接口返回分页结果。使用
    page[number]
    和
    page[size]
    查询参数来翻页，可查看响应中的
    meta.total_pages
    获取总页数。

List call events

列出通话事件

Filters call events by given filter parameters. Events are ordered by 
occurred_at
. If filter for 
leg_id
or 
application_session_id
is not present, it only filters events from the last 24 hours.
GET /call_events
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/call_events"
Returns: 
call_leg_id
(string), 
call_session_id
(string), 
event_timestamp
(string), 
metadata
(object), 
name
(string), 
record_type
(enum: call_event), 
type
(enum: command, webhook)
根据给定的筛选参数筛选通话事件。事件按
occurred_at
排序。如果未提供
leg_id
或
application_session_id
筛选条件，仅会返回过去24小时内的事件。
GET /call_events
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/call_events"
返回值：
call_leg_id
(字符串)，
call_session_id
(字符串)，
event_timestamp
(字符串)，
metadata
(对象)，
name
(字符串)，
record_type
(枚举值: call_event)，
type
(枚举值: command, webhook)

Create a ledger billing group report

创建分类账计费组报告

POST /ledger_billing_group_reports
Optional: 
month
(integer), 
year
(integer)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "year": 2019,
  "month": 10
}' \
  "https://api.telnyx.com/v2/ledger_billing_group_reports"
Returns: 
created_at
(date-time), 
id
(uuid), 
organization_id
(uuid), 
record_type
(enum: ledger_billing_group_report), 
report_url
(uri), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(date-time)
POST /ledger_billing_group_reports
可选参数：
month
(整数)，
year
(整数)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "year": 2019,
  "month": 10
}' \
  "https://api.telnyx.com/v2/ledger_billing_group_reports"
返回值：
created_at
(日期时间)，
id
(uuid)，
organization_id
(uuid)，
record_type
(枚举值: ledger_billing_group_report)，
report_url
(uri)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(日期时间)

Get a ledger billing group report

获取分类账计费组报告

GET /ledger_billing_group_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ledger_billing_group_reports/f5586561-8ff0-4291-a0ac-84fe544797bd"
Returns: 
created_at
(date-time), 
id
(uuid), 
organization_id
(uuid), 
record_type
(enum: ledger_billing_group_report), 
report_url
(uri), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(date-time)
GET /ledger_billing_group_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ledger_billing_group_reports/f5586561-8ff0-4291-a0ac-84fe544797bd"
返回值：
created_at
(日期时间)，
id
(uuid)，
organization_id
(uuid)，
record_type
(枚举值: ledger_billing_group_report)，
report_url
(uri)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(日期时间)

Get all MDR detailed report requests

获取所有MDR明细报告请求

Retrieves all MDR detailed report requests for the authenticated user
GET /legacy/reporting/batch_detail_records/messaging
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging"
Returns: 
connections
(array[integer]), 
created_at
(date-time), 
directions
(array[string]), 
end_date
(date-time), 
filters
(array[object]), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
record_types
(array[string]), 
report_name
(string), 
report_url
(string), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
获取已认证用户的所有MDR明细报告请求
GET /legacy/reporting/batch_detail_records/messaging
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging"
返回值：
connections
(整数数组)，
created_at
(日期时间)，
directions
(字符串数组)，
end_date
(日期时间)，
filters
(对象数组)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
record_types
(字符串数组)，
report_name
(字符串)，
report_url
(字符串)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Create a new MDR detailed report request

创建新的MDR明细报告请求

Creates a new MDR detailed report request with the specified filters
POST /legacy/reporting/batch_detail_records/messaging
— Required: 
start_time
, 
end_time
Optional: 
connections
(array[integer]), 
directions
(array[integer]), 
filters
(array[object]), 
include_message_body
(boolean), 
managed_accounts
(array[string]), 
profiles
(array[string]), 
record_types
(array[integer]), 
report_name
(string), 
select_all_managed_accounts
(boolean), 
timezone
(string)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_time": "2024-02-01T00:00:00Z",
  "end_time": "2024-02-12T23:59:59Z"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging"
Returns: 
connections
(array[integer]), 
created_at
(date-time), 
directions
(array[string]), 
end_date
(date-time), 
filters
(array[object]), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
record_types
(array[string]), 
report_name
(string), 
report_url
(string), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
使用指定筛选条件创建新的MDR明细报告请求
POST /legacy/reporting/batch_detail_records/messaging
— 必填参数：
start_time
, 
end_time
可选参数：
connections
(整数数组)，
directions
(整数数组)，
filters
(对象数组)，
include_message_body
(布尔值)，
managed_accounts
(字符串数组)，
profiles
(字符串数组)，
record_types
(整数数组)，
report_name
(字符串)，
select_all_managed_accounts
(布尔值)，
timezone
(字符串)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_time": "2024-02-01T00:00:00Z",
  "end_time": "2024-02-12T23:59:59Z"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging"
返回值：
connections
(整数数组)，
created_at
(日期时间)，
directions
(字符串数组)，
end_date
(日期时间)，
filters
(对象数组)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
record_types
(字符串数组)，
report_name
(字符串)，
report_url
(字符串)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Get a specific MDR detailed report request

获取指定MDR明细报告请求

Retrieves a specific MDR detailed report request by ID
GET /legacy/reporting/batch_detail_records/messaging/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/550e8400-e29b-41d4-a716-446655440000"
Returns: 
connections
(array[integer]), 
created_at
(date-time), 
directions
(array[string]), 
end_date
(date-time), 
filters
(array[object]), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
record_types
(array[string]), 
report_name
(string), 
report_url
(string), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
根据ID获取指定的MDR明细报告请求
GET /legacy/reporting/batch_detail_records/messaging/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/550e8400-e29b-41d4-a716-446655440000"
返回值：
connections
(整数数组)，
created_at
(日期时间)，
directions
(字符串数组)，
end_date
(日期时间)，
filters
(对象数组)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
record_types
(字符串数组)，
report_name
(字符串)，
report_url
(字符串)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Delete a MDR detailed report request

删除MDR明细报告请求

Deletes a specific MDR detailed report request by ID
DELETE /legacy/reporting/batch_detail_records/messaging/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/550e8400-e29b-41d4-a716-446655440000"
Returns: 
connections
(array[integer]), 
created_at
(date-time), 
directions
(array[string]), 
end_date
(date-time), 
filters
(array[object]), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
record_types
(array[string]), 
report_name
(string), 
report_url
(string), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
根据ID删除指定的MDR明细报告请求
DELETE /legacy/reporting/batch_detail_records/messaging/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/550e8400-e29b-41d4-a716-446655440000"
返回值：
connections
(整数数组)，
created_at
(日期时间)，
directions
(字符串数组)，
end_date
(日期时间)，
filters
(对象数组)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
record_types
(字符串数组)，
report_name
(字符串)，
report_url
(字符串)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Get all CDR report requests

获取所有CDR报告请求

Retrieves all CDR report requests for the authenticated user
GET /legacy/reporting/batch_detail_records/voice
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice"
Returns: 
call_types
(array[integer]), 
connections
(array[integer]), 
created_at
(string), 
end_time
(string), 
filters
(array[object]), 
id
(string), 
managed_accounts
(array[string]), 
record_type
(string), 
record_types
(array[integer]), 
report_name
(string), 
report_url
(string), 
retry
(int32), 
source
(string), 
start_time
(string), 
status
(int32), 
timezone
(string), 
updated_at
(string)
获取已认证用户的所有CDR报告请求
GET /legacy/reporting/batch_detail_records/voice
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice"
返回值：
call_types
(整数数组)，
connections
(整数数组)，
created_at
(字符串)，
end_time
(字符串)，
filters
(对象数组)，
id
(字符串)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
record_types
(整数数组)，
report_name
(字符串)，
report_url
(字符串)，
retry
(int32)，
source
(字符串)，
start_time
(字符串)，
status
(int32)，
timezone
(字符串)，
updated_at
(字符串)

Create a new CDR report request

创建新的CDR报告请求

Creates a new CDR report request with the specified filters
POST /legacy/reporting/batch_detail_records/voice
— Required: 
start_time
, 
end_time
Optional: 
call_types
(array[integer]), 
connections
(array[integer]), 
fields
(array[string]), 
filters
(array[object]), 
include_all_metadata
(boolean), 
managed_accounts
(array[string]), 
record_types
(array[integer]), 
report_name
(string), 
select_all_managed_accounts
(boolean), 
source
(string), 
timezone
(string)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_time": "2024-02-01T00:00:00Z",
  "end_time": "2024-02-12T23:59:59Z"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice"
Returns: 
call_types
(array[integer]), 
connections
(array[integer]), 
created_at
(string), 
end_time
(string), 
filters
(array[object]), 
id
(string), 
managed_accounts
(array[string]), 
record_type
(string), 
record_types
(array[integer]), 
report_name
(string), 
report_url
(string), 
retry
(int32), 
source
(string), 
start_time
(string), 
status
(int32), 
timezone
(string), 
updated_at
(string)
使用指定筛选条件创建新的CDR报告请求
POST /legacy/reporting/batch_detail_records/voice
— 必填参数：
start_time
, 
end_time
可选参数：
call_types
(整数数组)，
connections
(整数数组)，
fields
(字符串数组)，
filters
(对象数组)，
include_all_metadata
(布尔值)，
managed_accounts
(字符串数组)，
record_types
(整数数组)，
report_name
(字符串)，
select_all_managed_accounts
(布尔值)，
source
(字符串)，
timezone
(字符串)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_time": "2024-02-01T00:00:00Z",
  "end_time": "2024-02-12T23:59:59Z"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice"
返回值：
call_types
(整数数组)，
connections
(整数数组)，
created_at
(字符串)，
end_time
(字符串)，
filters
(对象数组)，
id
(字符串)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
record_types
(整数数组)，
report_name
(字符串)，
report_url
(字符串)，
retry
(int32)，
source
(字符串)，
start_time
(字符串)，
status
(int32)，
timezone
(字符串)，
updated_at
(字符串)

Get available CDR report fields

获取可用的CDR报告字段

Retrieves all available fields that can be used in CDR reports
GET /legacy/reporting/batch_detail_records/voice/fields
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/fields"
Returns: 
Billing
(array[string]), 
Interaction Data
(array[string]), 
Number Information
(array[string]), 
Telephony Data
(array[string])
获取CDR报告中可使用的所有可用字段
GET /legacy/reporting/batch_detail_records/voice/fields
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/fields"
返回值：
Billing
(字符串数组)，
Interaction Data
(字符串数组)，
Number Information
(字符串数组)，
Telephony Data
(字符串数组)

Get a specific CDR report request

获取指定CDR报告请求

Retrieves a specific CDR report request by ID
GET /legacy/reporting/batch_detail_records/voice/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/550e8400-e29b-41d4-a716-446655440000"
Returns: 
call_types
(array[integer]), 
connections
(array[integer]), 
created_at
(string), 
end_time
(string), 
filters
(array[object]), 
id
(string), 
managed_accounts
(array[string]), 
record_type
(string), 
record_types
(array[integer]), 
report_name
(string), 
report_url
(string), 
retry
(int32), 
source
(string), 
start_time
(string), 
status
(int32), 
timezone
(string), 
updated_at
(string)
根据ID获取指定的CDR报告请求
GET /legacy/reporting/batch_detail_records/voice/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/550e8400-e29b-41d4-a716-446655440000"
返回值：
call_types
(整数数组)，
connections
(整数数组)，
created_at
(字符串)，
end_time
(字符串)，
filters
(对象数组)，
id
(字符串)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
record_types
(整数数组)，
report_name
(字符串)，
report_url
(字符串)，
retry
(int32)，
source
(字符串)，
start_time
(字符串)，
status
(int32)，
timezone
(字符串)，
updated_at
(字符串)

Delete a CDR report request

删除CDR报告请求

Deletes a specific CDR report request by ID
DELETE /legacy/reporting/batch_detail_records/voice/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/550e8400-e29b-41d4-a716-446655440000"
Returns: 
call_types
(array[integer]), 
connections
(array[integer]), 
created_at
(string), 
end_time
(string), 
filters
(array[object]), 
id
(string), 
managed_accounts
(array[string]), 
record_type
(string), 
record_types
(array[integer]), 
report_name
(string), 
report_url
(string), 
retry
(int32), 
source
(string), 
start_time
(string), 
status
(int32), 
timezone
(string), 
updated_at
(string)
根据ID删除指定的CDR报告请求
DELETE /legacy/reporting/batch_detail_records/voice/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/550e8400-e29b-41d4-a716-446655440000"
返回值：
call_types
(整数数组)，
connections
(整数数组)，
created_at
(字符串)，
end_time
(字符串)，
filters
(对象数组)，
id
(字符串)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
record_types
(整数数组)，
report_name
(字符串)，
report_url
(字符串)，
retry
(int32)，
source
(字符串)，
start_time
(字符串)，
status
(int32)，
timezone
(字符串)，
updated_at
(字符串)

List MDR usage reports

列出MDR使用报告

Fetch all previous requests for MDR usage reports.
GET /legacy/reporting/usage_reports/messaging
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
获取所有历史MDR使用报告请求
GET /legacy/reporting/usage_reports/messaging
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Create a new legacy usage V2 MDR report request

创建新的旧版V2 MDR使用报告请求

Creates a new legacy usage V2 MDR report request with the specified filters
POST /legacy/reporting/usage_reports/messaging
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
使用指定筛选条件创建新的旧版V2 MDR使用报告请求
POST /legacy/reporting/usage_reports/messaging
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Get an MDR usage report

获取MDR使用报告

Fetch single MDR usage report by id.
GET /legacy/reporting/usage_reports/messaging/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
根据ID获取单个MDR使用报告
GET /legacy/reporting/usage_reports/messaging/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Delete a V2 legacy usage MDR report request

删除V2旧版MDR使用报告请求

Deletes a specific V2 legacy usage MDR report request by ID
DELETE /legacy/reporting/usage_reports/messaging/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
profiles
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
根据ID删除指定的V2旧版MDR使用报告请求
DELETE /legacy/reporting/usage_reports/messaging/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
profiles
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

List telco data usage reports

列出电信数据使用报告

Retrieve a paginated list of telco data usage reports
GET /legacy/reporting/usage_reports/number_lookup
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup"
Returns: 
aggregation_type
(string), 
created_at
(date-time), 
end_date
(date), 
id
(uuid), 
managed_accounts
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date), 
status
(string), 
updated_at
(date-time)
获取电信数据使用报告的分页列表
GET /legacy/reporting/usage_reports/number_lookup
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup"
返回值：
aggregation_type
(字符串)，
created_at
(日期时间)，
end_date
(日期)，
id
(uuid)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期)，
status
(字符串)，
updated_at
(日期时间)

Submit telco data usage report

提交电信数据使用报告

Submit a new telco data usage report
POST /legacy/reporting/usage_reports/number_lookup
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup"
Returns: 
aggregation_type
(string), 
created_at
(date-time), 
end_date
(date), 
id
(uuid), 
managed_accounts
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date), 
status
(string), 
updated_at
(date-time)
提交新的电信数据使用报告
POST /legacy/reporting/usage_reports/number_lookup
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup"
返回值：
aggregation_type
(字符串)，
created_at
(日期时间)，
end_date
(日期)，
id
(uuid)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期)，
status
(字符串)，
updated_at
(日期时间)

Get telco data usage report by ID

根据ID获取电信数据使用报告

Retrieve a specific telco data usage report by its ID
GET /legacy/reporting/usage_reports/number_lookup/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(string), 
created_at
(date-time), 
end_date
(date), 
id
(uuid), 
managed_accounts
(array[string]), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date), 
status
(string), 
updated_at
(date-time)
根据ID获取指定的电信数据使用报告
GET /legacy/reporting/usage_reports/number_lookup/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(字符串)，
created_at
(日期时间)，
end_date
(日期)，
id
(uuid)，
managed_accounts
(字符串数组)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期)，
status
(字符串)，
updated_at
(日期时间)

Delete telco data usage report

删除电信数据使用报告

Delete a specific telco data usage report by its ID
DELETE /legacy/reporting/usage_reports/number_lookup/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/550e8400-e29b-41d4-a716-446655440000"
根据ID删除指定的电信数据使用报告
DELETE /legacy/reporting/usage_reports/number_lookup/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/550e8400-e29b-41d4-a716-446655440000"

List CDR usage reports

列出CDR使用报告

Fetch all previous requests for cdr usage reports.
GET /legacy/reporting/usage_reports/voice
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
product_breakdown
(int32), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
获取所有历史CDR使用报告请求
GET /legacy/reporting/usage_reports/voice
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
product_breakdown
(int32)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Create a new legacy usage V2 CDR report request

创建新的旧版V2 CDR使用报告请求

Creates a new legacy usage V2 CDR report request with the specified filters
POST /legacy/reporting/usage_reports/voice
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
product_breakdown
(int32), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
使用指定筛选条件创建新的旧版V2 CDR使用报告请求
POST /legacy/reporting/usage_reports/voice
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
product_breakdown
(int32)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Get a CDR usage report

获取CDR使用报告

Fetch single cdr usage report by id.
GET /legacy/reporting/usage_reports/voice/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
product_breakdown
(int32), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
根据ID获取单个CDR使用报告
GET /legacy/reporting/usage_reports/voice/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
product_breakdown
(int32)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

Delete a V2 legacy usage CDR report request

删除V2旧版CDR使用报告请求

Deletes a specific V2 legacy usage CDR report request by ID
DELETE /legacy/reporting/usage_reports/voice/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(int32), 
connections
(array[string]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
product_breakdown
(int32), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(int32), 
updated_at
(date-time)
根据ID删除指定的V2旧版CDR使用报告请求
DELETE /legacy/reporting/usage_reports/voice/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(int32)，
connections
(字符串数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
product_breakdown
(int32)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(int32)，
updated_at
(日期时间)

List CSV downloads

列出CSV下载任务

GET /phone_numbers/csv_downloads
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/phone_numbers/csv_downloads"
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
GET /phone_numbers/csv_downloads
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/phone_numbers/csv_downloads"
返回值：
id
(字符串)，
record_type
(字符串)，
status
(枚举值: pending, complete, failed, expired)，
url
(字符串)

Create a CSV download

创建CSV下载任务

POST /phone_numbers/csv_downloads
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/phone_numbers/csv_downloads"
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
POST /phone_numbers/csv_downloads
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/phone_numbers/csv_downloads"
返回值：
id
(字符串)，
record_type
(字符串)，
status
(枚举值: pending, complete, failed, expired)，
url
(字符串)

Retrieve a CSV download

获取CSV下载任务

GET /phone_numbers/csv_downloads/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/phone_numbers/csv_downloads/550e8400-e29b-41d4-a716-446655440000"
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
GET /phone_numbers/csv_downloads/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/phone_numbers/csv_downloads/550e8400-e29b-41d4-a716-446655440000"
返回值：
id
(字符串)，
record_type
(字符串)，
status
(枚举值: pending, complete, failed, expired)，
url
(字符串)

Generates and fetches CDR Usage Reports

生成并获取CDR使用报告

Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
GET /reports/cdr_usage_reports/sync
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/cdr_usage_reports/sync?start_date=2020-07-01T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00&aggregation_type=NO_AGGREGATION&product_breakdown=NO_BREAKDOWN&connections=[1234567890123]"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, CONNECTION, TAG, BILLING_GROUP), 
connections
(array[integer]), 
created_at
(date-time), 
end_time
(date-time), 
id
(uuid), 
product_breakdown
(enum: NO_BREAKDOWN, DID_VS_TOLL_FREE, COUNTRY, DID_VS_TOLL_FREE_PER_COUNTRY), 
record_type
(string), 
report_url
(string), 
result
(object), 
start_time
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
同步生成并获取语音使用报告。该接口会同时生成并获取指定时间段内的语音报告，无需轮询，但响应最多可能需要几分钟时间。
GET /reports/cdr_usage_reports/sync
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/cdr_usage_reports/sync?start_date=2020-07-01T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00&aggregation_type=NO_AGGREGATION&product_breakdown=NO_BREAKDOWN&connections=[1234567890123]"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, CONNECTION, TAG, BILLING_GROUP)，
connections
(整数数组)，
created_at
(日期时间)，
end_time
(日期时间)，
id
(uuid)，
product_breakdown
(枚举值: NO_BREAKDOWN, DID_VS_TOLL_FREE, COUNTRY, DID_VS_TOLL_FREE_PER_COUNTRY)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象)，
start_time
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Fetch all Messaging usage reports

获取所有短信使用报告

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
GET /reports/mdr_usage_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, PROFILE, TAGS), 
connections
(array[integer]), 
created_at
(date-time), 
end_date
(date-time), 
id
(uuid), 
profiles
(string), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
获取所有短信使用报告。使用报告是指定时间段和细分维度的聚合短信数据
GET /reports/mdr_usage_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, PROFILE, TAGS)，
connections
(整数数组)，
created_at
(日期时间)，
end_date
(日期时间)，
id
(uuid)，
profiles
(字符串)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Create MDR Usage Report

创建MDR使用报告

Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.
POST /reports/mdr_usage_reports
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/reports/mdr_usage_reports"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, PROFILE, TAGS), 
connections
(array[integer]), 
created_at
(date-time), 
end_date
(date-time), 
id
(uuid), 
profiles
(string), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
提交新的短信使用报告请求。该接口会拉取并聚合指定时间段内的短信数据。
POST /reports/mdr_usage_reports
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/reports/mdr_usage_reports"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, PROFILE, TAGS)，
connections
(整数数组)，
created_at
(日期时间)，
end_date
(日期时间)，
id
(uuid)，
profiles
(字符串)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Generate and fetch MDR Usage Report

生成并获取MDR使用报告

Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
GET /reports/mdr_usage_reports/sync
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports/sync?start_date=2020-07-01T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00&aggregation_type=PROFILE&profiles=['My profile']"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, PROFILE, TAGS), 
connections
(array[integer]), 
created_at
(date-time), 
end_date
(date-time), 
id
(uuid), 
profiles
(string), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
同步生成并获取短信使用报告。该接口会同时生成并获取指定时间段内的短信报告，无需轮询，但响应最多可能需要几分钟时间。
GET /reports/mdr_usage_reports/sync
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports/sync?start_date=2020-07-01T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00&aggregation_type=PROFILE&profiles=['My profile']"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, PROFILE, TAGS)，
connections
(整数数组)，
created_at
(日期时间)，
end_date
(日期时间)，
id
(uuid)，
profiles
(字符串)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Retrieve messaging report

获取短信报告

Fetch a single messaging usage report by id
GET /reports/mdr_usage_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, PROFILE, TAGS), 
connections
(array[integer]), 
created_at
(date-time), 
end_date
(date-time), 
id
(uuid), 
profiles
(string), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
根据ID获取单个短信使用报告
GET /reports/mdr_usage_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdr_usage_reports/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, PROFILE, TAGS)，
connections
(整数数组)，
created_at
(日期时间)，
end_date
(日期时间)，
id
(uuid)，
profiles
(字符串)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Delete MDR Usage Report

删除MDR使用报告

Delete messaging usage report by id
DELETE /reports/mdr_usage_reports/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/reports/mdr_usage_reports/550e8400-e29b-41d4-a716-446655440000"
Returns: 
aggregation_type
(enum: NO_AGGREGATION, PROFILE, TAGS), 
connections
(array[integer]), 
created_at
(date-time), 
end_date
(date-time), 
id
(uuid), 
profiles
(string), 
record_type
(string), 
report_url
(string), 
result
(array[object]), 
start_date
(date-time), 
status
(enum: PENDING, COMPLETE, FAILED, EXPIRED), 
updated_at
(date-time)
根据ID删除短信使用报告
DELETE /reports/mdr_usage_reports/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/reports/mdr_usage_reports/550e8400-e29b-41d4-a716-446655440000"
返回值：
aggregation_type
(枚举值: NO_AGGREGATION, PROFILE, TAGS)，
connections
(整数数组)，
created_at
(日期时间)，
end_date
(日期时间)，
id
(uuid)，
profiles
(字符串)，
record_type
(字符串)，
report_url
(字符串)，
result
(对象数组)，
start_date
(日期时间)，
status
(枚举值: PENDING, COMPLETE, FAILED, EXPIRED)，
updated_at
(日期时间)

Fetch all Mdr records

获取所有MDR记录

GET /reports/mdrs
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdrs?id=e093fbe0-5bde-11eb-ae93-0242ac130002&direction=INBOUND&profile=My profile&cld=+15551237654&cli=+15551237654&status=DELIVERED&message_type=SMS"
Returns: 
cld
(string), 
cli
(string), 
cost
(string), 
created_at
(date-time), 
currency
(enum: AUD, CAD, EUR, GBP, USD), 
direction
(string), 
id
(string), 
message_type
(enum: SMS, MMS), 
parts
(number), 
profile_name
(string), 
rate
(string), 
record_type
(string), 
status
(enum: GW_TIMEOUT, DELIVERED, DLR_UNCONFIRMED, DLR_TIMEOUT, RECEIVED, GW_REJECT, FAILED)
GET /reports/mdrs
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/mdrs?id=e093fbe0-5bde-11eb-ae93-0242ac130002&direction=INBOUND&profile=My profile&cld=+15551237654&cli=+15551237654&status=DELIVERED&message_type=SMS"
返回值：
cld
(字符串)，
cli
(字符串)，
cost
(字符串)，
created_at
(日期时间)，
currency
(枚举值: AUD, CAD, EUR, GBP, USD)，
direction
(字符串)，
id
(字符串)，
message_type
(枚举值: SMS, MMS)，
parts
(数字)，
profile_name
(字符串)，
rate
(字符串)，
record_type
(字符串)，
status
(枚举值: GW_TIMEOUT, DELIVERED, DLR_UNCONFIRMED, DLR_TIMEOUT, RECEIVED, GW_REJECT, FAILED)

Fetches all Wdr records

获取所有WDR记录

Fetch all Wdr records
GET /reports/wdrs
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/wdrs?start_date=2021-05-01T00:00:00Z&end_date=2021-06-01T00:00:00Z&id=e093fbe0-5bde-11eb-ae93-0242ac130002&mcc=204&mnc=01&imsi=123456&sim_group_name=sim name&sim_group_id=f05a189f-7c46-4531-ac56-1460dc465a42&sim_card_id=877f80a6-e5b2-4687-9a04-88076265720f&phone_number=+12345678910&sort=['created_at']"
Returns: 
cost
(object), 
created_at
(date-time), 
downlink_data
(object), 
duration_seconds
(number), 
id
(string), 
imsi
(string), 
mcc
(string), 
mnc
(string), 
phone_number
(string), 
rate
(object), 
record_type
(string), 
sim_card_id
(string), 
sim_group_id
(string), 
sim_group_name
(string), 
uplink_data
(object)
获取所有WDR记录
GET /reports/wdrs
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/reports/wdrs?start_date=2021-05-01T00:00:00Z&end_date=2021-06-01T00:00:00Z&id=e093fbe0-5bde-11eb-ae93-0242ac130002&mcc=204&mnc=01&imsi=123456&sim_group_name=sim name&sim_group_id=f05a189f-7c46-4531-ac56-1460dc465a42&sim_card_id=877f80a6-e5b2-4687-9a04-88076265720f&phone_number=+12345678910&sort=['created_at']"
返回值：
cost
(对象)，
created_at
(日期时间)，
downlink_data
(对象)，
duration_seconds
(数字)，
id
(字符串)，
imsi
(字符串)，
mcc
(字符串)，
mnc
(字符串)，
phone_number
(字符串)，
rate
(对象)，
record_type
(字符串)，
sim_card_id
(字符串)，
sim_group_id
(字符串)，
sim_group_name
(字符串)，
uplink_data
(对象)

Get metadata overview

获取元数据概览

Returns all available record types and supported query parameters for session analysis.
GET /session_analysis/metadata
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/metadata"
Returns: 
meta
(object), 
query_parameters
(object), 
record_types
(array[object])
返回会话分析可用的所有记录类型和支持的查询参数。
GET /session_analysis/metadata
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/metadata"
返回值：
meta
(对象)，
query_parameters
(对象)，
record_types
(对象数组)

Get record type metadata

获取记录类型元数据

Returns detailed metadata for a specific record type, including relationships and examples.
GET /session_analysis/metadata/{record_type}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/metadata/{record_type}"
Returns: 
aliases
(array[string]), 
child_relationships
(array[object]), 
event
(string), 
examples
(object), 
meta
(object), 
parent_relationships
(array[object]), 
product
(string), 
record_type
(string)
返回指定记录类型的详细元数据，包括关联关系和示例。
GET /session_analysis/metadata/{record_type}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/metadata/{record_type}"
返回值：
aliases
(字符串数组)，
child_relationships
(对象数组)，
event
(字符串)，
examples
(对象)，
meta
(对象)，
parent_relationships
(对象数组)，
product
(字符串)，
record_type
(字符串)

Get session analysis

获取会话分析结果

Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages.
GET /session_analysis/{record_type}/{event_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/{record_type}/{event_id}"
Returns: 
completed_at
(date-time), 
cost
(object), 
created_at
(date-time), 
meta
(object), 
root
(object), 
session_id
(string), 
status
(string)
获取指定事件的完整会话分析树，包括成本、子事件和产品关联关系。
GET /session_analysis/{record_type}/{event_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/session_analysis/{record_type}/{event_id}"
返回值：
completed_at
(日期时间)，
cost
(对象)，
created_at
(日期时间)，
meta
(对象)，
root
(对象)，
session_id
(字符串)，
status
(字符串)

Get Telnyx product usage data (BETA)

获取Telnyx产品使用数据（测试版）

Get Telnyx usage data by product, broken out by the specified dimensions
GET /usage_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/usage_reports"
Returns: 
data
(array[object]), 
meta
(object)
按产品获取Telnyx使用数据，按指定维度拆分
GET /usage_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/usage_reports"
返回值：
data
(对象数组)，
meta
(对象)

Get Usage Reports query options (BETA)

获取使用报告查询选项（测试版）

Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions
GET /usage_reports/options
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/usage_reports/options"
Returns: 
product
(string), 
product_dimensions
(array[string]), 
product_metrics
(array[string]), 
record_types
(array[object])
获取查询使用情况的使用报告选项，包括可用产品及其对应的指标和维度
GET /usage_reports/options
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/usage_reports/options"
返回值：
product
(字符串)，
product_dimensions
(字符串数组)，
product_metrics
(字符串数组)，
record_types
(对象数组)

Get all Wireless Detail Records (WDRs) Reports

获取所有无线详单记录(WDR)报告

Returns the WDR Reports that match the given parameters.
GET /wireless/detail_records_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireless/detail_records_reports"
Returns: 
created_at
(string), 
end_time
(string), 
id
(uuid), 
record_type
(string), 
report_url
(string), 
start_time
(string), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(string)
返回符合给定参数的WDR报告
GET /wireless/detail_records_reports
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireless/detail_records_reports"
返回值：
created_at
(字符串)，
end_time
(字符串)，
id
(uuid)，
record_type
(字符串)，
report_url
(字符串)，
start_time
(字符串)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(字符串)

Create a Wireless Detail Records (WDRs) Report

创建无线详单记录(WDR)报告

Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
POST /wireless/detail_records_reports
Optional: 
end_time
(string), 
start_time
(string)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/wireless/detail_records_reports"
Returns: 
created_at
(string), 
end_time
(string), 
id
(uuid), 
record_type
(string), 
report_url
(string), 
start_time
(string), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(string)
异步创建包含指定时间段内消耗无线数据的SIM卡的无线详单记录(WDR)报告。
POST /wireless/detail_records_reports
可选参数：
end_time
(字符串)，
start_time
(字符串)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/wireless/detail_records_reports"
返回值：
created_at
(字符串)，
end_time
(字符串)，
id
(uuid)，
record_type
(字符串)，
report_url
(字符串)，
start_time
(字符串)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(字符串)

Get a Wireless Detail Record (WDR) Report

获取无线详单记录(WDR)报告

Returns one specific WDR report
GET /wireless/detail_records_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Returns: 
created_at
(string), 
end_time
(string), 
id
(uuid), 
record_type
(string), 
report_url
(string), 
start_time
(string), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(string)
返回指定的WDR报告
GET /wireless/detail_records_reports/{id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
返回值：
created_at
(字符串)，
end_time
(字符串)，
id
(uuid)，
record_type
(字符串)，
report_url
(字符串)，
start_time
(字符串)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(字符串)

Delete a Wireless Detail Record (WDR) Report

删除无线详单记录(WDR)报告

Deletes one specific WDR report.
DELETE /wireless/detail_records_reports/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Returns: 
created_at
(string), 
end_time
(string), 
id
(uuid), 
record_type
(string), 
report_url
(string), 
start_time
(string), 
status
(enum: pending, complete, failed, deleted), 
updated_at
(string)
删除指定的WDR报告。
DELETE /wireless/detail_records_reports/{id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/wireless/detail_records_reports/6a09cdc3-8948-47f0-aa62-74ac943d6c58"
返回值：
created_at
(字符串)，
end_time
(字符串)，
id
(uuid)，
record_type
(字符串)，
report_url
(字符串)，
start_time
(字符串)，
status
(枚举值: pending, complete, failed, deleted)，
updated_at
(字符串)