Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: 使用状況記録 (Usage Records)

The Usage Records resource returns aggregated usage for all SIMs on an Account. To retrieve usage for a single SIM, use the SIM Usage Records resource.

The Usage Records list resource returns total usage information for all SIMs on an Account. Usage data is gathered over a specified period, presented as a list, aggregated according to the user-provided granularity.

https://wireless.twilio.com/v1/UsageRecords

Usage Record Properties

This resource and its subresources always return a list of Usage Records. Each Usage Record is represented by the following properties:

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that created the AccountUsageRecord resource.

period
オブジェクト Not PII

The time period for which usage is reported. Contains start and end properties that describe the period using GMT date-time values specified in ISO 8601 format.

commands
オブジェクト Not PII

An object that describes the aggregated Commands usage for all SIMs during the specified period. See Commands Usage Object.

data
オブジェクト Not PII

An object that describes the aggregated Data usage for all SIMs over the period. See Data Usage Object.

Commands Usageオブジェクト

Command Usageオブジェクトは期間中のCommandの使用状況をレポートします。 使用状況の詳細は3つに区分けされています: Total(合計)、Home(自国)、そしてNational Roaming(ローミング)です。

The Commands Usage object is presented as a tree-like structure. For example, the total value from the home, national_roaming, and international_roaming child objects sum to the total value of the top level commands object. The same computations are done for the to_sim and from_sim parameters in the top level object.

プロパティ Type 概要 空の値
total integer The total number of Commands sent (from_sim) or received (to_sim) by all SIMs linked to the account over the given period. 0
to_sim integer The number of Commands received by all SIMs linked to the account (to_sim) throughout the period. 0
from_sim integer The number of Commands sent by all SIMs linked to the account (from_sim) throughout the period. 0
ホーム オブジェクト An embedded Commands Usage Object that describes the number of Commands received by all SIMs linked to the account on the home network throughout the period, with keys total, to_sim and from_sim. null
national_roaming オブジェクト An embedded Commands Usage Object that describes the number of Commands received by all SIMs linked to the account on national roaming partner networks throughout the period, with keys total, to_sim and from_sim. null
international_roaming オブジェクト An embedded Commands Usage Object that describes the number of Commands received by all SIMs linked to the account on international roaming partner networks throughout the period, with keys total, to_sim and from_sim. []
Data Usageオブジェクト

Data Usageオブジェクトは期間中のDataの使用状況をレポートします。使用状況の詳細は3つに区分けされています: Total(合計)、Home(自国)、そしてNational Roaming(ローミング)です。

Data Usageオブジェクトはツリーライクな構造で表されます。 たとえば、home子オブジェクト、およびnational_roaming子オブジェクトからのtotal値は、トップレベルdataオブジェクトのtotal値の合計になります。 これは、downloadおよびuploadパラメーターについても同様です。

プロパティ Type 概要 空の値
total integer 期間内における、SIMに接続されたデバイスによるData消費(ダウンロードおよびアップロード)の総量です。 0
ダウンロード integer 期間内における、SIMに接続されたデバイスによるDataダウンロードの総量です。 0
upload integer 期間内における、SIMに接続されたデバイスによるDataアップロードの総量です。 0
units 文字列 現在のオブジェクトに対して報告されるデータ使用状況の単位です。 もっとも一般的なのは「bytes(バイト)」です。 該当なし
ホーム オブジェクト totaldownloadupload、およびunitsキーを伴う、期間内にホームネットワーク上でSIMに接続されたデバイスが消費したDataを表す埋め込み済Data Usageオブジェクトです。 null
national_roaming オブジェクト totaldownloadupload、およびunitsキーを伴う、期間内にローミングパートナーネットワーク上でSIMに接続されたデバイスが消費したDataを表す埋め込み済Data Usageオブジェクトです。 null
international_roaming オブジェクト An embedded Data Usage Object that describes the amount of Data consumed by the SIM-connected device on international roaming partner networks throughout the period, with keys total, download, upload and units. null

List all Usage Records for an Account

GET
https://wireless.twilio.com/v1/UsageRecords

HTTP GET

Returns a list of Usage Records for an account.

パラメーター
Names in None format
end
オプション
GET date_time<iso8601> Not PII

この日付、もしくはそれ以前に発生した利用のみが含まれます。形式はISO 8601です。

start
オプション
GET date_time<iso8601> Not PII

この日付、もしくはそれ以降に発生した利用のみが含まれます。形式はISO 8601です。

granularity
オプション
GET enum:granularity Not PII

How to summarize the usage by time. Can be: daily, hourly, or all. A value of all returns one Usage Record that describes the usage for the entire period.

例 1
        
        
        
        

        HTTP POST

        サポートされていません。

        HTTP PUT

        サポートされていません。

        HTTP DELETE

        サポートされていません。

        Rate this page:

        ヘルプが必要ですか?

        誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。