Back to Details

telnyx-account-reports-javascript

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Account Reports - JavaScript

Telnyx账户报告 - JavaScript

Installation

安装

bash
npm install telnyx
bash
npm install telnyx

Setup

设置

javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
All examples below assume 
client
is already initialized as shown above.
javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
以下所有示例均假设
client
已按上述方式初始化。

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:
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}
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).
所有API调用都可能因网络错误、速率限制（429）、验证错误（422）或认证错误（401）而失败。在生产代码中务必处理错误：
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}
常见错误码：
401
无效API密钥，
403
权限不足，
404
资源未找到，
422
验证错误（检查字段格式），
429
速率限制（使用指数退避重试）。

Important Notes

重要注意事项

  • Pagination: List methods return an auto-paginating iterator. Use 
    for await (const item of result) { ... }
    to iterate through all pages automatically.
  • 分页： 列表方法返回一个自动分页的迭代器。使用
    for await (const item of result) { ... }
    自动遍历所有页面。

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
javascript
// Automatically fetches more pages as needed.
for await (const callEventListResponse of client.callEvents.list()) {
  console.log(callEventListResponse.call_leg_id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const callEventListResponse of client.callEvents.list()) {
  console.log(callEventListResponse.call_leg_id);
}
返回：
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)
javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.create({
  month: 10,
  year: 2019,
});

console.log(ledgerBillingGroupReport.data);
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
（整数）
javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.create({
  month: 10,
  year: 2019,
});

console.log(ledgerBillingGroupReport.data);
返回：
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}
javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.retrieve(
  'f5586561-8ff0-4291-a0ac-84fe544797bd',
);

console.log(ledgerBillingGroupReport.data);
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}
javascript
const ledgerBillingGroupReport = await client.ledgerBillingGroupReports.retrieve(
  'f5586561-8ff0-4291-a0ac-84fe544797bd',
);

console.log(ledgerBillingGroupReport.data);
返回：
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
javascript
const messagings = await client.legacy.reporting.batchDetailRecords.messaging.list();

console.log(messagings.data);
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
javascript
const messagings = await client.legacy.reporting.batchDetailRecords.messaging.list();

console.log(messagings.data);
返回：
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)
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.create({
  end_time: '2024-02-12T23:59:59Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(messaging.data);
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
（字符串）
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.create({
  end_time: '2024-02-12T23:59:59Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(messaging.data);
返回：
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}
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
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}
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
返回：
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}
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
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}
javascript
const messaging = await client.legacy.reporting.batchDetailRecords.messaging.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
返回：
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
javascript
const voices = await client.legacy.reporting.batchDetailRecords.voice.list();

console.log(voices.data);
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
javascript
const voices = await client.legacy.reporting.batchDetailRecords.voice.list();

console.log(voices.data);
返回：
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)
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.create({
  end_time: '2024-02-12T23:59:59Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(voice.data);
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
（字符串）
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.create({
  end_time: '2024-02-12T23:59:59Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(voice.data);
返回：
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
javascript
const response = await client.legacy.reporting.batchDetailRecords.voice.retrieveFields();

console.log(response.Billing);
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
javascript
const response = await client.legacy.reporting.batchDetailRecords.voice.retrieveFields();

console.log(response.Billing);
返回：
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}
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
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}
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
返回：
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}
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
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}
javascript
const voice = await client.legacy.reporting.batchDetailRecords.voice.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.messaging.list()) {
  console.log(mdrUsageReportResponseLegacy.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.messaging.list()) {
  console.log(mdrUsageReportResponseLegacy.id);
}
返回：
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
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.create({
  aggregation_type: 0,
});

console.log(messaging.data);
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
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.create({
  aggregation_type: 0,
});

console.log(messaging.data);
返回：
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}
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
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}
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
返回：
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}
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
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}
javascript
const messaging = await client.legacy.reporting.usageReports.messaging.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(messaging.data);
返回：
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
javascript
const numberLookups = await client.legacy.reporting.usageReports.numberLookup.list();

console.log(numberLookups.data);
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
javascript
const numberLookups = await client.legacy.reporting.usageReports.numberLookup.list();

console.log(numberLookups.data);
返回：
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
javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.create();

console.log(numberLookup.data);
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
javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.create();

console.log(numberLookup.data);
返回：
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}
javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberLookup.data);
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}
javascript
const numberLookup = await client.legacy.reporting.usageReports.numberLookup.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberLookup.data);
返回：
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}
javascript
await client.legacy.reporting.usageReports.numberLookup.delete('550e8400-e29b-41d4-a716-446655440000');
通过ID删除特定的电信数据使用报告
DELETE /legacy/reporting/usage_reports/number_lookup/{id}
javascript
await client.legacy.reporting.usageReports.numberLookup.delete('550e8400-e29b-41d4-a716-446655440000');

List CDR usage reports

列出CDR使用报告

Fetch all previous requests for cdr usage reports.
GET /legacy/reporting/usage_reports/voice
javascript
// Automatically fetches more pages as needed.
for await (const cdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.voice.list()) {
  console.log(cdrUsageReportResponseLegacy.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const cdrUsageReportResponseLegacy of client.legacy.reporting.usageReports.voice.list()) {
  console.log(cdrUsageReportResponseLegacy.id);
}
返回：
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
javascript
const voice = await client.legacy.reporting.usageReports.voice.create({
  end_time: '2024-02-01T00:00:00Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(voice.data);
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
javascript
const voice = await client.legacy.reporting.usageReports.voice.create({
  end_time: '2024-02-01T00:00:00Z',
  start_time: '2024-02-01T00:00:00Z',
});

console.log(voice.data);
返回：
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}
javascript
const voice = await client.legacy.reporting.usageReports.voice.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
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}
javascript
const voice = await client.legacy.reporting.usageReports.voice.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
返回：
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}
javascript
const voice = await client.legacy.reporting.usageReports.voice.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
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}
javascript
const voice = await client.legacy.reporting.usageReports.voice.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(voice.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const csvDownload of client.phoneNumbers.csvDownloads.list()) {
  console.log(csvDownload.id);
}
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
GET /phone_numbers/csv_downloads
javascript
// Automatically fetches more pages as needed.
for await (const csvDownload of client.phoneNumbers.csvDownloads.list()) {
  console.log(csvDownload.id);
}
返回：
id
（字符串）、
record_type
（字符串）、
status
（枚举：pending, complete, failed, expired）、
url
（字符串）

Create a CSV download

创建CSV下载

POST /phone_numbers/csv_downloads
javascript
const csvDownload = await client.phoneNumbers.csvDownloads.create();

console.log(csvDownload.data);
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
POST /phone_numbers/csv_downloads
javascript
const csvDownload = await client.phoneNumbers.csvDownloads.create();

console.log(csvDownload.data);
返回：
id
（字符串）、
record_type
（字符串）、
status
（枚举：pending, complete, failed, expired）、
url
（字符串）

Retrieve a CSV download

检索CSV下载

GET /phone_numbers/csv_downloads/{id}
javascript
const csvDownload = await client.phoneNumbers.csvDownloads.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(csvDownload.data);
Returns: 
id
(string), 
record_type
(string), 
status
(enum: pending, complete, failed, expired), 
url
(string)
GET /phone_numbers/csv_downloads/{id}
javascript
const csvDownload = await client.phoneNumbers.csvDownloads.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(csvDownload.data);
返回：
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
javascript
const response = await client.reports.cdrUsageReports.fetchSync({
  aggregation_type: 'NO_AGGREGATION',
  product_breakdown: 'NO_BREAKDOWN',
});

console.log(response.data);
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
javascript
const response = await client.reports.cdrUsageReports.fetchSync({
  aggregation_type: 'NO_AGGREGATION',
  product_breakdown: 'NO_BREAKDOWN',
});

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
  console.log(mdrUsageReport.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
  console.log(mdrUsageReport.id);
}
返回：
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
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.create({
  aggregation_type: 'NO_AGGREGATION',
  end_date: '2020-07-01T00:00:00-06:00',
  start_date: '2020-07-01T00:00:00-06:00',
});

console.log(mdrUsageReport.data);
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
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.create({
  aggregation_type: 'NO_AGGREGATION',
  end_date: '2020-07-01T00:00:00-06:00',
  start_date: '2020-07-01T00:00:00-06:00',
});

console.log(mdrUsageReport.data);
返回：
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
javascript
const response = await client.reports.mdrUsageReports.fetchSync({ aggregation_type: 'PROFILE' });

console.log(response.data);
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
javascript
const response = await client.reports.mdrUsageReports.fetchSync({ aggregation_type: 'PROFILE' });

console.log(response.data);
返回：
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}
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(mdrUsageReport.data);
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}
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(mdrUsageReport.data);
返回：
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}
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(mdrUsageReport.data);
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}
javascript
const mdrUsageReport = await client.reports.mdrUsageReports.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(mdrUsageReport.data);
返回：
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
javascript
const response = await client.reports.listMdrs();

console.log(response.data);
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
javascript
const response = await client.reports.listMdrs();

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const reportListWdrsResponse of client.reports.listWdrs()) {
  console.log(reportListWdrsResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const reportListWdrsResponse of client.reports.listWdrs()) {
  console.log(reportListWdrsResponse.id);
}
返回：
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
javascript
const metadata = await client.sessionAnalysis.metadata.retrieve();

console.log(metadata.meta);
Returns: 
meta
(object), 
query_parameters
(object), 
record_types
(array[object])
返回所有可用记录类型及会话分析支持的查询参数。
GET /session_analysis/metadata
javascript
const metadata = await client.sessionAnalysis.metadata.retrieve();

console.log(metadata.meta);
返回：
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}
javascript
const response = await client.sessionAnalysis.metadata.retrieveRecordType('record_type');

console.log(response.aliases);
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}
javascript
const response = await client.sessionAnalysis.metadata.retrieveRecordType('record_type');

console.log(response.aliases);
返回：
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}
javascript
const sessionAnalysis = await client.sessionAnalysis.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { record_type: 'record_type' },
);

console.log(sessionAnalysis.session_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}
javascript
const sessionAnalysis = await client.sessionAnalysis.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { record_type: 'record_type' },
);

console.log(sessionAnalysis.session_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
javascript
// Automatically fetches more pages as needed.
for await (const usageReportListResponse of client.usageReports.list({
  dimensions: ['string'],
  metrics: ['string'],
  product: 'wireless',
})) {
  console.log(usageReportListResponse);
}
Returns: 
data
(array[object]), 
meta
(object)
按产品获取Telnyx使用数据，并按指定维度细分
GET /usage_reports
javascript
// Automatically fetches more pages as needed.
for await (const usageReportListResponse of client.usageReports.list({
  dimensions: ['string'],
  metrics: ['string'],
  product: 'wireless',
})) {
  console.log(usageReportListResponse);
}
返回：
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
javascript
const response = await client.usageReports.getOptions();

console.log(response.data);
Returns: 
product
(string), 
product_dimensions
(array[string]), 
product_metrics
(array[string]), 
record_types
(array[object])
获取用于查询使用情况的使用报告选项，包括可用产品及其对应的指标和维度
GET /usage_reports/options
javascript
const response = await client.usageReports.getOptions();

console.log(response.data);
返回：
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
javascript
const detailRecordsReports = await client.wireless.detailRecordsReports.list();

console.log(detailRecordsReports.data);
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
javascript
const detailRecordsReports = await client.wireless.detailRecordsReports.list();

console.log(detailRecordsReports.data);
返回：
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)
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.create();

console.log(detailRecordsReport.data);
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
（字符串）
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.create();

console.log(detailRecordsReport.data);
返回：
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}
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.retrieve(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(detailRecordsReport.data);
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}
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.retrieve(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(detailRecordsReport.data);
返回：
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}
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.delete(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(detailRecordsReport.data);
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}
javascript
const detailRecordsReport = await client.wireless.detailRecordsReports.delete(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(detailRecordsReport.data);
返回：
created_at
（字符串）、
end_time
（字符串）、
id
（uuid）、
record_type
（字符串）、
report_url
（字符串）、
start_time
（字符串）、
status
（枚举：pending, complete, failed, deleted）、
updated_at
（字符串）