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: SIM Usage Records

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

SIM Usage Recordsリストリソースは、指定された期間のSIMに対する利用情報を返します。 これは一覧として表され、ユーザーの提供した精度にしたがって収集されます。

HTTPリソースとメソッド

SIM Usage リストリソース

リソースURL

https://wireless.twilio.com/v1/Sims/{SimSid}/UsageRecords
https://wireless.twilio.com/v1/Sims/{SimUniqueName}/UsageRecords

リソースのプロパティ

このリソース、およびそのサブリソースは常にSIM Usage Records(SIMの使用状況記録)の一覧を返します。 各Usage Recordは下記のプロパティーによって表されます:

Names in PHP format
simSid
sid_like<DE> Not PII

The SID of the Sim resource that this Usage Record is for.

accountSid
sid<AC> Not PII

The SID of the Account that created the UsageRecord resource.

period
オブジェクト Not PII

The time period for which the usage is reported. Contains start and end datetime values given as GMT in ISO 8601 format.

commands
オブジェクト Not PII

An object that describes the SIM's usage of Commands during the specified period. See Commands Usage Object.

data
オブジェクト Not PII

An object that describes the SIM's data usage during the specified period. See Data Usage Object.

commands and data usage objects below have properties for home, national_roaming, and international_roaming.

  • home refers to usage incurred in the United States on the T-Moble USA network.
  • national_roaming refers to usage incurred in the United States on networks other than the T-Mobile USA network.
  • international_roaming refers to usage incurred in any country other than the United States.
Commands Usageオブジェクト

The Commands usage object reports usage of Commands for the period.

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

プロパティ Type 概要 空の値
total integer 期間中にSIMから送信(from_sim)または受信(to_sim)されたCommandの合計数です。 0
to_sim integer 期間に渡ってSIMが受信した(to_sim)Commandの数です。 0
from_sim integer 期間に渡ってSIMが送信した(from_sim)Commandの数です。 0
ホーム オブジェクト totalto_sim、およびfrom_simキーを伴う、期間内にホームネットワーク上でSIMが受信したCommand数を表す埋め込み済Command Usageオブジェクトです。 null
national_roaming オブジェクト totalto_sim、およびfrom_simキーを伴う、期間内にローミングパートナーのネットワーク上でSIMが受信したCommand数を表す埋め込み済Command Usageオブジェクトです。 null
international_roaming 配列 An array of Commands Usage Objects, one for each country with usage, that describes the number of Commands received by or sent from the SIM on international roaming partner networks throughout the period, with keys total, to_sim and from_sim. []
Data Usageオブジェクト

The Data usage object reports usage of Data for the period.

The Data Usage object is presented as a tree-like structure. For example, the total value from the home child object, the national_roaming child object, and the international_roaming child object sum to the total value of the top level data object. This is the same for the download and upload parameters.

プロパティ 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 array of Data Usage Objects, one for each country with usage, 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. []

SIM Usage Recordリストリソース

HTTP GET

SidまたはUnique Name(一意な名前)で識別されるSIMに対するUsage Recordsを返します。

期間フィルター

既定では、SIM Usage Recordsリストリソースは過去の月のUsage Records(使用状況記録)を返します。 異なる期間の使用状況を取得するには、以下のパラメーターを使用します:

パラメーター 概要 初期値
end この日付、もしくはそれ以前に発生した利用のみが含まれます。形式はISO 8601です。 現在
スタート! この日付、もしくはそれ以降に発生した利用のみが含まれます。形式はISO 8601です。 終了1ヶ月前
他の一覧フィルター

下記のGETクエリー文字列パラメーターで、返される一覧を変更できます。 パラメーターの大文字と小文字は区別されます。

パラメーター 概要 初期値
Granularity 時間ベースのグルーピングに使用する期間の基準です。 有効な値はdailyhourlyallです。 allは全期間に渡る1つのUsage Recordsを返します。 all

JSONで表現され、SIM Sidを使用した先月におけるdaily(日次)SIM Usage Recordsの一覧をリクエストします。

        
        
        
        

        HTTP POST

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

        HTTP PUT

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

        HTTP DELETE

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

        Rate this page:

        ヘルプが必要ですか?

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