メインコンテンツへスキップダイレクトメッセージは、X上での非公開のやり取りを可能にします。ダイレクトメッセージはXで最も人気のある機能の一つで、活用シーンも多岐にわたります。友人同士のグループチャットから、世界中のブランドのカスタマーサポートまで幅広く利用されています。ダイレクトメッセージの新しい v2 エンドポイントは段階的に提供され、最初の段階では、ダイレクトメッセージの作成とダイレクトメッセージ会話イベントの一覧取得に関する基本的なエンドポイントが含まれます。X API v2 では初めて、グループ会話がサポートされます。
Manage Direct Messages の初回リリースには、ダイレクトメッセージを作成するための3つの POST メソッドが含まれます:
- POST /2/dm_conversations/with/:participant_id/messages - 1対1のダイレクトメッセージを作成します。このメソッドは、新しい 1対1 の会話を作成するか、現在の会話を取得してその会話にダイレクトメッセージを追加します。:participant_id パスパラメータは、メッセージの受信アカウントのユーザーIDです。
- POST /2/dm_conversations - 新しいグループ会話を作成し、ダイレクトメッセージを追加します。これらのリクエストには、会話参加者のリストが必要です。同じ参加者リストで複数の会話を作成できる点に注意してください。これらのリクエストは常に新しい会話IDを返します。
- POST /2/dm_conversations/:dm_conversation_id/messages - 既存の会話にダイレクトメッセージを作成して追加します。:dm_conversation_id パスパラメータは、メッセージを追加する会話のIDです。
ダイレクトメッセージのイベントIDは v1.1 と v2(および X アプリ)で共通のため、非表示/削除の v1.1 メソッドはこの新しい v2 エンドポイントと併用できます。また、エンタープライズおよび Premium Account Activity API は v2 の 1対1 メッセージをサポートしていますが、グループ会話はまだサポートしていない点にも注意してください。
POST メソッドには、15分あたり200リクエストのユーザー単位のレート制限があります。さらに、ユーザーごとに24時間あたり1000リクエストのレート制限があります。加えて、24時間あたり15000リクエストのレート制限があります。これらのレート制限は、ここで紹介した POST エンドポイント間で共有されます。
manage Posts エンドポイントでユーザーに代わってリクエストを行うため、OAuth 1.0a User Context または OAuth 2.0 Authorization Code with PKCE で認証し、あなたのアプリを認可したユーザーに紐づくユーザー 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 エンドポイントへのアクセス方法の詳細は、はじめにガイドをご覧ください。