請求データ参照
大事なThe Billing Usage API is in Early Access. Interactive API reference documentation will be available when the API is generally released on June 10, 2026.
Billing Usage API で使用できるすべてのコスト フィールド、請求カテゴリ、サブカテゴリ、集計ディメンションの参照。
コスト フィールド
これらのフィールドは、各集計の組み合わせの Billing Usage API レスポンスに表示されます。
| フィールド | 説明 | 形式 |
|---|---|---|
| ユニット | 課金の計測基準(メッセージ、メッセージ部分、セッション、分、月間アクティブユーザー) | 糸 |
| 単価 | 標準通貨単位での単位あたりのコスト | Decimal関数 |
| 量 | 請求されたユニットの合計数。現在のカテゴリでは、これは常に整数です。将来のカテゴリは、10 進値を返す場合があります。 | 番号 |
| ユニットあたりの合計 | 標準通貨単位での合計請求額 (単価に数量を乗じた値) | Decimal関数 |
| 通貨 | 請求通貨 (ISO 4217) | 文字列 (USD、EUR、GBP など) |
カテゴリ
| コード | 表示名 |
|---|---|
SMS | SMS |
SMS_OPERATOR_FEE | SMS - オペレーター料金(米国の航空会社サーチャージ) |
MMS | MMS |
MMS_OPERATOR_FEE | MMS - オペレーター料金 |
EMAIL | メール |
RCS | RCS |
WHATSAPP | |
VIBER | Viber |
MOBILE_PUSH | モバイルプッシュ通知 |
NUMBER_LOOKUP | 番号検索 |
CARRIER_LOOKUP | キャリアルックアップ |
EMAIL_VALIDATION | 電子メールの検証 |
AGENTOS | エージェントOS |
手記US operator fees (
SMS_OPERATOR_FEE, MMS_OPERATOR_FEE) are carrier pass-through costs itemized separately from base message costs.サブカテゴリ
一部のカテゴリには、サービスバリアントの詳細な内訳を提供するサブカテゴリがあります。
| コード | カテゴリ | 表示名 | 説明 |
|---|---|---|---|
VIBER_BM | Viber | Viber BM | Viberビジネスメッセージ |
VIBER_BOTS | Viber | Viberチャットボット | Viberチャットボット |
寸法
[動作] 列では、次の値が使用されます。
| 動作 | 意味 |
|---|---|
| 自動追加されたデフォルト | このペアのディメンションが指定されていない場合、aggregateBy に自動的に追加されます |
| 選択 | aggregateBy に明示的に追加する |
| 濃縮 | 新しいデータ グループを作成せずに、既存のディメンションと並んで列を追加します。 |
| データグループ | ディメンション | APIコード | 説明 | 適用 | 動作 |
|---|---|---|---|---|---|
| Account (アカウント) | Account (アカウント) | ACCOUNT_NAME | NTT CPaaSアカウント名 | 自動追加されたデフォルト | |
| Account (アカウント) | アカウントキー | ACCOUNT_KEY | プログラムによる処理のためのハッシュ化されたアカウント識別子 | 選択 | |
| Account (アカウント) | ユーザー名 | USER_NAME | トラフィックを開始したユーザーの一意のユーザー名 | 選択 | |
| Account (アカウント) | アプリケーション | APPLICATION_ID | NTT CPaaSマルチテナントプラットフォーム内のアプリケーションに割り当てられる一意の識別子 | 選択 | |
| Account (アカウント) | エンティティ | ENTITY_ID | NTT CPaaSマルチテナントプラットフォーム内のエンティティに割り当てられる一意の識別子 | 選択 | |
| サービスとトラフィック | カテゴリ | CATEGORY_NAME | 通信チャネルまたはサービスの表示名 (SMS、WhatsApp、RCS など) | 選択 | |
| サービスとトラフィック | カテゴリ コード | CATEGORY_CODE | フィルタリングとグループ化に使用されるカテゴリ列挙コード。カテゴリを参照してください。 | 自動追加されたデフォルト | |
| サービスとトラフィック | 方向 | 「ディレクション」 | トラフィックが顧客に送信されたか (アウトバウンド) か、顧客から受信されたか (インバウンド) を示します。 | 選択 | |
| サービスとトラフィック | トラフィックの種類 | TRAFFIC_TYPE | 追加のトラフィック分類 (たとえば、RCS single、basic、A2P、P2A)。 | 選択 | |
| サービスとトラフィック | サブカテゴリ名 | SUBCATEGORY_NAME | サービスバリアントの表示名(Viber Business Messagesなど) | 選択 | |
| サービスとトラフィック | サブカテゴリコード | SUBCATEGORY_CODE | サービスバリアント列挙コード (VIBER_BM など)。サブカテゴリを参照してください。 | 選択 | |
| Sender (送信者) | Sender (送信者) | 「送信者」 | トラフィックの送信に使用される送信者、番号、またはドメイン | 選択 | |
| Sender (送信者) | 送信者の種類 | SENDER_TYPE | 送信者のタイプを指定します(VLN、ショートコード、英数字、フリーダイヤル、10DLC、ドメイン) | 選択 | |
| 地理とネットワーク | Country (国) | COUNTRY_NAME | トラフィックが送信された宛先国の名前 | 選択。エンリッチメント: 国コード、国プレフィックス | |
| 地理とネットワーク | 国コード | COUNTRY_CODE | 公式の 2 文字の国コード (ISO 3166-1 alpha-2) | 濃縮 | |
| 地理とネットワーク | ネットワーク | NETWORK_NAME | モバイル ネットワーク事業者の名前 (利用可能な場合) | 選択。エンリッチメント: ネットワーク コード | |
| 地理とネットワーク | ネットワークコード | NORM_NET_CODE | モバイルネットワーク事業者を識別するMCC+MNCコード | 濃縮 | |
| 地理とネットワーク | 国の接頭辞 | COUNTRY_PREFIX | 宛先の国の国際ダイヤルプレフィックス | 濃縮 | |
| キャンペーンとメッセージのメタデータ | キャンペーン ID | CAMPAIGN_ID | ブロードキャストまたはジャーニーの一意の識別子 | 選択 | |
| キャンペーンとメッセージのメタデータ | キャンペーンリファレンス | CAMPAIGN_REFERENCE | NTT CPaaS API または統合を介して送信されるトラフィックのキャンペーン参照 ID | 選択 | |
| キャンペーンとメッセージのメタデータ | テンプレート ID | TEMPLATE_ID | WhatsAppテンプレートの一意の識別子 | 選択 | |
| 日付のグループ化 | Day関数 | 日 | 1 日の集計データを表す日付 | 選択 | |
| 日付のグループ化 | Month関数 | MONTH (月) | 集計データを表す月 | 選択 |
Related pages
Query billing data
Build and send a billing usage query and handle the callback response.
Billing Usage API
Overview of the API, supported channels, and data finalization behavior.