メインコンテンツへスキップこの初期リリースのダイレクトメッセージのルックアップには、次の3つのGETメソッドが含まれます:
- GET /2/dm_conversations/with/:participant_id/dm_events - 1対1の会話に関連するダイレクトメッセージイベントを取得します。:participant_id パスパラメータは、このリクエストを行う認証済みユーザーと会話しているアカウントのユーザーIDです。
- GET /2/dm_conversations/:dm_conversation_id/dm_events - :dm_conversation_id パスパラメータで示される特定の会話IDに関連するダイレクトメッセージイベントを取得します。
- GET /2/dm_events - ユーザーに関連するダイレクトメッセージイベントを、1対1およびグループ会話の両方を含めて取得します。最大30日前までのイベントが利用可能です。
ダイレクトメッセージのイベントIDは v1.1 と v2（および X アプリ）間で共通のため、単一イベントを取得する v1.1 のメソッドを、これらの新しい v2 エンドポイントと併用できます。なお、エンタープライズおよび Premium Account Activity API は v2 の1対1メッセージをサポートしていますが、グループ会話はまだサポートしていません。
このリリースでは3つのイベントタイプがサポートされており、これらのエンドポイントはそれらをフィルタリングするためのクエリパラメータに対応しています:
- MessageCreate - メッセージが作成されました。
- ParticipantsJoin - 新しい参加者が会話に参加しました。
- ParticipantsLeave - 参加者が会話から退出しました。
GET メソッドには、15分あたり300リクエストのユーザー単位のレート制限があります。このレート制限は、これらの GET エンドポイント間で共有されます。
ダイレクトメッセージの v2 エンドポイントでユーザーに代わってリクエストを行うため、OAuth 1.0a User Context または OAuth 2.0 Authorization Code with PKCE のいずれかで認証し、あなたの X アプリを承認したユーザーに紐づく Access Token を使用する必要があります。OAuth 1.0a でこれらの Access Token を生成するには、3-legged OAuth flow を使用できます。OAuth 2.0 でユーザーの Access Token を生成するには、Authorization Code with PKCE grant flow を使用できます。
アカウントの設定
これらのエンドポイントにアクセスするには、次が必要です:
X API v2 エンドポイントへのアクセス方法の詳細は、はじめにガイドをご覧ください。
