メッセージ API ログ
Messages API Logsページでは、WhatsApp、SMS、RCS、MMS、Viber、Messenger、Instagramなど、サポートされている全てのチャンネルでMessages APIを通じて送信されたメッセージの検索やトラブルシューティングが可能です。このページを使用して、配信に関する問題の調査、各チャンネルでのメッセージステータスの検証、分析のためのログのダウンロードを行います。
注： SMSトラフィックを SMS APIを使用する。 SMS API ログ その代わりだ。
始める前に
- Messages APIログは、以下の場合に利用可能です。 30日間のみ
- 30日以上前のログについては Reports API
- ログが表示されるまで数分の遅れがある
- を設定する。 納品書ウェブフック リアルタイムのステータス更新
Messages API ログへのアクセス
- にログインする。 Vonage APIダッシュボード
- に移動する。 モニター → 過去ログ
- 選択 メッセージ API ログ
検索方法
Messages API Logsページには3つの検索方法がある：
時間範囲
特定の期間内のメッセージを検索し、全チャンネルのトラフィックを監視したり、特定のプロバイダーでフィルタリングしたりできます。
使用可能なフィルター：
- 時間範囲 - 直近1時間、直近24時間、直近7日間、直近30日間、またはカスタム範囲
- プロバイダー - WhatsApp、SMS、MMS、RCS、Viber、Messenger、Instagramのいずれか
- ディレクション - 送信または受信メッセージ
- メッセージ本文を含む - 結果にメッセージの内容を表示する
電話番号 / ID
特定の電話番号や外部アカウントIDに送信されたメッセージを検索し、顧客の問題を調査したり、配信をVerifyしたりします。
使用可能なフィルター：
- より - 送信者の電話番号またはアカウントID
- へ - 相手先の電話番号またはアカウントID
- プロバイダー - WhatsApp、SMS、MMS、RCS、Viber、Messenger、Instagramのいずれか
- ディレクション - アウトバウンドまたはインバウンド
- 時間範囲 - メッセージ送信時
- メッセージ本文を含む - 結果にメッセージの内容を表示する
ヒント WhatsAppの場合、電話番号またはWhatsAppビジネスアカウントID(WABA ID)で検索できます。
メッセージID
一意なメッセージIDを使用して、1つまたは複数の特定のメッセージを検索します。この方法は、API レスポンスや Webhook からメッセージ ID を取得している場合に最適です。
使用可能なフィルター：
- メッセージID - 1つ以上のカンマ区切りのメッセージUUID
- ディレクション - アウトバウンドまたはインバウンド
- メッセージ本文を含む - 結果にメッセージの内容を表示する
注： Messages APIはUUID形式のメッセージIDを使用し、SMS APIのメッセージIDとは異なります。
結果を出す
ログの詳細を見る
各ログエントリーには、メッセージに関する重要な情報が表示される：
- メッセージID - メッセージのユニークUUID
- チャンネル - メッセージングプロバイダー（WhatsApp、SMS、RCSなど）
- より - 送信者の電話番号またはアカウントID
- へ - 送信先の電話番号またはアカウントID
- ステータス - 配信ステータス（送信、配信、既読、拒否など）
- 時間 - メッセージの送信日またはステータスの更新日
- ネットワーク - モバイルネットワーク事業者（SMS/MMS/RCSのみ）
- 価格 - メッセージの費用
メッセージ・ステータスを理解する
異なるチャンネルは異なるステータス値をサポートする：
| ステータス | 説明 | チャンネル |
|---|---|---|
| 提出済み | Vonageがメッセージを受理 | 全チャンネル |
| 配信 | メッセージが受信者に届く | 全チャンネル |
| 読む | 受信者がメッセージを読む | WhatsApp、Viber、Messenger、Instagram |
| 却下 | プロバイダがメッセージを拒否 | 全チャンネル |
| 未着 | メッセージの配信に失敗しました | 全チャンネル |
メッセージ本文を含む
デフォルトでは、プライバシーとパフォーマンスのため、メッセージの内容は表示されません。をチェックしてください。 メッセージ本文を含む オプションを選択すると、結果のメッセージ内容が表示されます。
重要だ： メッセージ本文の内容は、保存されている場合のみ利用可能です。チャンネルによっては、プライバシーポリシーのため、メッセージの内容を保持しない場合があります。
ログのダウンロード
検索結果をCSVにエクスポートして、オフラインで分析したり、記録したりできます。
ログをダウンロードするには
- 任意の方法で検索を行う
- クリック CSVダウンロード
- CSVファイルには、検索結果のすべてのフィールドが含まれます。
注： CSVダウンロードは表示された結果に限定されます。一括エクスポートやプログラムによるアクセスには Reports API.
ログの遅延を理解する
- 通常のログ： 送信後2～5分で利用可能
- 納品書： チャンネルによって異なる：
- WhatsAppほぼリアルタイム（秒）
- SMS/MMS：ネットワークオペレータによる（数秒～数時間）
- RCSほぼリアルタイム（秒）
- ソーシャルチャンネルほぼリアルタイム（秒）
- リアルタイム更新： 用途 納品書ウェブフック 即時通知用