請求データ参照
財務レポート、請求使用状況 API、および AgentOS レポートから利用できるすべてのコスト フィールド、請求ディメンション、カテゴリ、サブカテゴリ、およびトラフィック タイプの参照。
コスト フィールド
これらのフィールドは、財務レポートと請求使用状況 API に適用されます。AgentOS レポートでは、異なるコスト構造が使用されます。特定のフィールドについては、AgentOS reportを参照してください。
| フィールド | 説明 | フォーマット |
|---|---|---|
| ユニット | 課金の測定基準 (メッセージ、メッセージ部分、セッション、分、または月間アクティブ ユーザー) | 糸 |
| 単価 | 標準通貨単位での単位あたりのコスト | Decimal関数 |
| 量 | 請求されたユニットの合計数。値は整数でも小数でもかまいません。 | 数字 |
| ユニットあたりの合計 | 標準通貨単位での合計請求額 (単価に数量を乗じた値) | Decimal関数 |
| 通貨 | 請求通貨 (ISO 4217) | 文字列 (USD、EUR、GBP など) |
カテゴリ
| コード | 表示名 |
|---|---|
AGENTOS | エージェントOS |
AI | AIの |
APPLE_MB | Apple Messages for Business |
CARRIER_LOOKUP | キャリアルックアップ |
| 「メール」 | メール |
EMAIL_VALIDATION | 電子メールの検証 |
MMS | MMSです |
MMS_OPERATOR_FEE | MMS - オペレーター料金 |
MOBILE_PUSH | モバイルプッシュ通知 |
NUMBER_LOOKUP | 番号検索 |
RCS | RCS |
SMS | SMS |
SMS_OPERATOR_FEE | SMS - オペレーター料金(米国の航空会社サーチャージ) |
| 「バイバー」 | Viber |
VOICE_VIDEO | VoiceとVideo |
| 「ワッツアップ」 |
SMS_OPERATOR_FEE、MMS_OPERATOR_FEE)は、基本メッセージコストとは別に項目化された通信事業者のパススルーコストです。サブカテゴリ
一部のカテゴリには、サービスバリアントの詳細な内訳を提供するサブカテゴリがあります。財務諸表では、Voice and Video を選択するとサブカテゴリが自動的に追加され、Voice and Video サブカテゴリは Technologies と Add-ons にグループ化されます。Viberのサブカテゴリーは、Billing Usage APIを通じてのみ利用できます。
| コード | カテゴリー | 表示名 |
|---|---|---|
VIBER_BM | Viber | Viberビジネスメッセージ |
VIBER_BOTS | Viber | Viberチャットボット |
| 「電話」 | VoiceとVideo | 電話 |
WEBRTC | VoiceとVideo | WebRTC |
WHATSAPP_BC | VoiceとVideo | WhatsApp Business 通話 |
VIBER_BC | VoiceとVideo | Viberビジネスコール |
SPEECH_CAPTURE | VoiceとVideo | 音声キャプチャ |
SPEECH_TRANSCRIPTION | VoiceとVideo | 音声の文字起こし |
NEURAL_TEXT_TO_SPEECH | VoiceとVideo | ニューラルテキスト読み上げ |
| 「会議」 | VoiceとVideo | 電話会議 |
AUDIO_STREAMING | VoiceとVideo | オーディオストリーミング |
VOICE_RECORDING | VoiceとVideo | Voice録音 |
RECORDING_STORAGE | VoiceとVideo | 記録ストレージ |
MISSED_CALL | VoiceとVideo | 不在着信 |
VOICE_AMD | VoiceとVideo | 自動機械検出 |
VIDEO_COMPOSITION | VoiceとVideo | 映像構成 |
チャネル別のトラフィックタイプ
RCS
| コード | 説明 |
|---|---|
| 「ベーシック」 | RCS基本メッセージ(米国市場以外) |
| 「シングル」 | RCS 単一メッセージ (米国市場以外) |
| 「A2P_会話」 | RCS A2P (Application-to-Person) 会話 (米国市場以外) |
| 「P2A_会話」 | RCS P2A (Person-to-Application) 会話 (米国市場以外) |
| 「リッチ」 | RCS リッチ メッセージング (米国市場のみ) |
RICH_MEDIA | RCS リッチメディア メッセージング(米国市場のみ) |
INTERACTIVE_SESSION | RCSインタラクティブセッション(米国市場のみ) |
| コード | 説明 |
|---|---|
| 「マーケティング」 | WhatsAppマーケティングメッセージ |
| 「ユーティリティ」 | WhatsAppユーティリティメッセージ |
| 「認証」 | WhatsApp認証メッセージ |
AUTHENTICATION_INTERNATIONAL | WhatsApp 国際認証メッセージ |
FREE_FORM | WhatsAppフリーフォームメッセージ |
MM_LITE | WhatsApp MM Lite メッセージ |
Viber Business Messages
各Viberトラフィックタイプには、標準と規制されたバリアントがあります。REGULATED_プレフィックスは、規制された市場で送信されるメッセージに適用されます。
| コード | 規制バリアント | 説明 |
|---|---|---|
| 「トランザクション」 | REGULATED_TRANSACTIONAL | Viber BMトランザクションメッセージ |
| 「プロモーション」 | REGULATED_PROMOTIONAL | Viber BMプロモーションメッセージ |
OTP | '規制_OTP' | Viber BM OTPメッセージ |
| 「インターナショナル」 | REGULATED_INTERNATIONAL | Viber BM国際メッセージ |
| 「セッション」 | REGULATED_SESSION | Viber BMセッションメッセージ |
寸法
[動作] 列では、次の値が使用されます。
| 動作 | 意味 |
|---|---|
| 常に含まれています | すべてのサーフェスのすべての結果に存在し、削除することはできません |
| 常に[サーフェス]に含まれる | 名前付きサーフェスのすべての結果にのみ存在します |
| 自動追加されたデフォルト | このペアのディメンションが指定されていない場合、aggregateBy に自動的に追加されます (Billing Usage API) |
| 選択 | レポートまたは API 要求を構成するときに明示的に追加する |
| [サーフェス]で選択可能 | 名前付きサーフェスでのみ使用できます |
| 財務諸表に自動追加されたサブディメンション。課金利用APIで選択可能 | 親分析コードが選択されると、財務諸表に自動的に追加されます。API で明示的に追加する必要があります |
| 濃縮 | 新しいデータ グループや追加の行を作成せずに、既存のディメンションの横に列を追加します。 |
| データグループ | ディメンション | APIコード | 説明 | 適用 | 動作 |
|---|---|---|---|---|---|
| Account (アカウント) | Account (アカウント) | ACCOUNT_NAME | NTT CPaaSアカウント名 | 常に財務報告書に含まれます。アカウント ディメンションが指定されていない場合、Billing Usage API に既定で自動追加されます | |
| Account (アカウント) | アカウントキー | ACCOUNT_KEY | プログラムによる処理のためのハッシュ化されたアカウント識別子 | 課金利用APIで選択可能 | |
| Account (アカウント) | ユーザー名 | USER_NAME | トラフィックを開始したユーザーの一意のユーザー名 | 選択 | |
| Account (アカウント) | 応用 | APPLICATION_ID | NTT CPaaSマルチテナントプラットフォーム内のアプリケーションに割り当てられる一意の識別子 | 選択 | |
| Account (アカウント) | エンティティ | ENTITY_ID | NTT CPaaSマルチテナントプラットフォーム内のエンティティに割り当てられる一意の識別子 | 選択 | |
| サービスとトラフィック | カテゴリ | CATEGORY_NAME | 通信チャネルまたはサービスの表示名 (SMS、WhatsApp、RCS など) | 常に財務報告書に含まれます。課金利用APIで選択可能 | |
| サービスとトラフィック | カテゴリ コード | CATEGORY_CODE | フィルタリングとグループ化に使用されるカテゴリ列挙コード。カテゴリを参照してください。 | カテゴリ ディメンションが指定されていない場合、Billing Usage API に既定で自動追加されます | |
| サービスとトラフィック | 方向 | 「ディレクション」 | トラフィックが顧客に送信されたか (アウトバウンド) か、顧客から受信されたか (インバウンド) を示します。 | 財務諸表に自動追加されたサブディメンション。課金利用APIで選択可能 | |
| サービスとトラフィック | トラフィックの種類 | TRAFFIC_TYPE | 追加のトラフィック分類(RCS シングル、ベーシック、A2P、P2A など)。チャネル別のトラフィックの種類 を参照してください。 | 財務諸表に自動追加されたサブディメンション。課金利用APIで選択可能 | |
| サービスとトラフィック | サブカテゴリ名 | SUBCATEGORY_NAME | サービスバリアントの表示名(Viber Business Messagesなど) | [Voice and Video] が選択されている場合、財務レポートに自動追加されます。Billing Usage APIで選択可能。 | |
| サービスとトラフィック | サブカテゴリコード | SUBCATEGORY_CODE | サービスバリアント列挙コード (VIBER_BM など)。サブカテゴリを参照してください。 | [Voice and Video] が選択されている場合、財務レポートに自動追加されます。Billing Usage APIで選択可能。 | |
| サービスとトラフィック | 請求時間単位 | BILLING_TIME_UNIT | Voice またはビデオ通話に適用される最小請求可能期間 (X) と丸め増分 (Y) は、秒単位の X/Y で表されます (例: 60/60)。確立されていない呼び出しの値は null です。 | 自動追加されたデフォルト。VOICE_VIDEOカテゴリが存在する場合に自動追加されます。通話ごとや文字ごとなど、異なる基準で請求されるサブカテゴリには適用されません。 | |
| Sender (送信者) | Sender (送信者) | 「送信者」 | トラフィックの送信に使用される送信者、番号、またはドメイン | 選択 | |
| Sender (送信者) | 送信者の種類 | SENDER_TYPE | 送信者のタイプを指定します(VLN、ショートコード、英数字、フリーダイヤル、10DLC、ドメイン) | エンリッチメント。[送信者] が選択されている場合に使用できます。Billing Usage APIで選択可能。 | |
| 地理とネットワーク | Country (国) | COUNTRY_NAME | トラフィックが送信された宛先国の名前 | 選択。エンリッチメント: 国コード、国プレフィックス | |
| 地理とネットワーク | 国コード | COUNTRY_CODE | 公式の 2 文字の国コード (ISO 3166-1 alpha-2) | エンリッチメント。[国] が選択されている場合に使用できます。 | |
| 地理とネットワーク | ネットワーク | NETWORK_NAME | ネットワーク オペレーターの名前 (使用可能な場合)。 モバイル以外のネットワーク(固定回線、VoIP)の場合、このフィールドは空白になる場合があります。 | 選択可能。エンリッチメント: ネットワークコード | |
| 地理とネットワーク | ネットワークコード | NORM_NET_CODE | モバイルネットワーク事業者を識別するMCC + MNCコード。 モバイル/セルラーネットワークにのみ適用されます。固定回線、VoIP、またはその他の非モバイル ネットワークでは空白になる場合があります。 | Enrichment in Billing Usage API | |
| 地理とネットワーク | 国の接頭辞 | COUNTRY_PREFIX | 宛先の国の国際ダイヤルプレフィックス | Enrichment in Billing Usage API | |
| キャンペーンとメッセージのメタデータ | キャンペーン ID | CAMPAIGN_ID | ブロードキャストまたはジャーニーの一意の識別子 | 選択可能。エンリッチメント: キャンペーン名。Billing Usage API は ID のみを返します。 | |
| キャンペーンとメッセージのメタデータ | キャンペーンリファレンス | CAMPAIGN_REFERENCE | NTT CPaaS API または統合を介して送信されるトラフィックのキャンペーン参照 ID | 選択 | |
| キャンペーンとメッセージのメタデータ | テンプレート ID | TEMPLATE_ID | WhatsAppテンプレートの一意の識別子 | 選択可能。エンリッチメント: テンプレート名。Billing Usage API は ID のみを返します。 | |
| 日付のグループ化 | Day関数 | 日 | 1 日の集計データを表す日付 | 選択可能。追加して、日ごとに結果を分類します。 | |
| 日付のグループ化 | Month関数 | MONTH (月) | 集計データを表す月 | 選択可能。Billing Usage API で複数月にまたがってクエリを実行するときに aggregateBy に追加します。 | |
| AgentOS(コストレポートのみ) | エンジンタイプ | — | トラフィックを処理した AgentOS コンポーネント: ジャーニー、ヒューマン (受信トレイ)、チャットボット、または AI エージェント | AgentOSレポートで選択可能 | |
| AgentOS(コストレポートのみ) | ジャーニー ID | — | Automation Studio ジャーニーの一意の識別子 | AgentOSレポートで選択可能 |
アカウント階層と可視性
デフォルトでは、財務レポート、請求使用状況 API、AgentOS は、自分のアカウント、関連するサブアカウント、および会社の下のすべてのアカウントなど、アカウント階層全体のすべてのリターンデータをレポートします。このクロスアカウントビューは、請求構造を反映しています。
この動作はデフォルトで設定されており、変更できません。サブアカウントでログインすると、自分のアカウントデータのみが表示されます。
結果を特定のアカウントに絞り込むには、アカウントフィルタ(財務レポート、AgentOS レポート)またはaccountKeysフィルタパラメータ(Billing Usage API)を使用します。
データの範囲とファイナライズ
これらの制約は、財務レポート、Billing Usage API、AgentOS レポートに適用されます。
- 保持期間: 当月および最大 2 か月前
- タイムゾーン: UTC。カスタム タイム ゾーンはサポートされていません。
- マルチデータセンター: データはデータセンターごとに生成され、アクセスされます。データセンター間の集約はサポートされていません。アカウントがホストされている場所を確認するには、アカウントマネージャーまたはサポートにお問い合わせください。
- 請求書発行の調整: 請求データは、NTT CPaaS 請求書と同じ月次サイクル、通貨形式、請求構造に従います。
データのファイナライズ [#data-finalization-data-scope-and-finalization]
- 暫定: 当月データは、請求書が発行される翌月5日に月が確定するまで変更される場合があります
- データが変更される理由: 遅延到着の交通記録、遡及的なボリュームベースの割引、および価格調整
- 請求使用状況 API: 応答には、毎月のステータスが
volumeFinalizedのmetadata.billingPeriods配列が含まれます。volumeFinalized: trueは、ユニット数が完了したことを意味します。請求書が発行されるまで、価格は変更される場合があります。レスポンスデータをご覧ください。
財務計画または請求の目的で請求データを使用する前に、必ず請求書と照合してください。
課金利用APIガイド
請求使用状況クエリを作成して送信し、コールバック応答を処理し、データのファイナライズを理解します。
決算報告
スケジューリングとエクスポートのオプションを備えたWebインターフェイスを介して、同じ請求データを表示します。