メニュー

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

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

このUsage Recordに対応するSIMリソースの一意なIDです。

accountSid
sid<AC> Not PII

SIMが属するアカウントの一意なIDです。

period
オブジェクト Not PII

使用状況を報告する期間です。 startおよびendプロパティーを含めて、開始および終了日をGMT(グリニッジ標準時)で、ISO 8601形式で表します。

commands
オブジェクト Not PII

期間内のSIMにおける、Commandの使用状況を表すオブジェクトです。 下記、Commands Usageオブジェクトを参照してください。

data
オブジェクト Not PII

期間内のSIMにおける、Dataの使用状況を表すオブジェクトです。 下記、Data Usageオブジェクトを参照してください。

Commands Usageオブジェクト

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

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

プロパティ 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 オブジェクト totalto_sim、およびfrom_simキーを伴う、期間内にローミングパートナーのネットワーク上でSIMが受信したCommand数を表す埋め込み済Command Usageオブジェクトです。 null
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

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
リストフィルター

下記のGETのクエリー文字列パラメーターを使用すると、返される一覧を制限することができます。 パラメーターは大文字と小文字を区別することに注意してください:

パラメーター 概要
Sim このSIMとの間で送受信されるコマンドのみを返します。
Status このステータス値を伴うコマンドのみを返します。
Direction この方向のコマンドのみを返します。

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

        
        
        
        

        HTTP POST

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

        HTTP PUT

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

        HTTP DELETE

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

        Rate this page:

        ヘルプが必要ですか?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.