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

Usage、Count、Price プロパティ

それぞれの利用記録では、3つの単位があります。Usage、Count、Priceです。Usageはそのカテゴリーで使われる主要単位で表示されます。音声通話時間ではminutes、SMSではmessages、イベント数ではCount、音声通話数ではcallsとなります。Priceは利用料の合計金額を表します。

それぞれの利用記録には、利用量の記録に用いる単位を示すフィールドがあります。たとえば、Usage の単位は UsageUnit です。 これらのフィールドを使って、利用一覧を表示するダッシュ ボードを簡単に作成することができます。 たとえばこれらのパラメーターを次のように変数に代入して組み合わせると、人間が読みやすい形式の文字列で利用状況を表すことができます。 「$Usage $UsageUnits (1分、3時間、など) 」、「$Count $CountUnits (25個、など) 」、「$Price $PriceUnits (500JPY、2USD、など) 」

利用カテゴリー

利用記録の Category で、その利用記録が表す利用種別を定義します。 完全なリストはここにありますが、通常よく使われるのは、次のカテゴリーです。

デフォルトでは、UsageRecord リソースは、Category ごとに 1 つの利用記録を返します。この利用記録は、アカウントに課金されたすべての利用を対象とし、期間の指定はありません。 利用を Category でフィルターするか、またはオプションの GET クエリ パラメーターを使用して、利用をカウントする日付の範囲を変更できます。 クエリ パラメーターの大文字と小文字は区別されますので、注意してください。

たとえば、2012 年 4 月のすべての利用記録をリクエストするとします。 ここではクエリ文字列は StartDate=2012-04-01&EndDate=2012-04-30 です。 4 月中の利用について、利用種別につき 1 つの利用記録が返ります。このリストは ページ情報を含みます。 後述の 例 2 を参照してください。

後述の サブリソース を使って、利用を日、月、年ごとにグループ化することもできます。

リスト サブリソース

メインの UsageRecords リスト リソースは、さまざまなサブリソースをサポートしており、便利に使えます。 原則として、次の形式を取ります。

/2010-04-01/Accounts/{AccountSid}/Usage/Records/{Subresource}

サポートするサブリソースは、次の通りです。

これらの便利なサブリソースを使って、日ごとの通話のグラフを作成したり、すべての利用カテゴリーの月間利用をダッシュ ボードに表示したり、先月の利用合計を元に利用料金の請求システムを構築できます。

すべてのサブリソースは、ルートの UsageCounter リソースと同じ リスト フィルター をサポートします。