Skip to main content

v1.1 と v2 の Manage Direct Message エンドポイントの比較

Direct Messages エンドポイントの v1.1 と v2 の両バージョンには、Direct Message を作成するためのメソッドが用意されています。このガイドは、両者の違いを理解し、v2 への移行に役立つ情報を提供することを目的としています。 両バージョン間の大きな違いは、v1.1 は 1 対 1 の会話のみをサポートしているのに対し、v2 ではグループ会話のサポートが導入されている点です。この結果として、v1.1 は「message created」イベントのみをサポートしていますが、v2 では会話への参加や退出に関連するイベントもサポートしています。実際、v2 の基本的な更新点として、dm_conversations がコア API オブジェクトとして確立されています。 v1.1 には Direct Messages を管理するための 2 つのエンドポイントがあります。
  • POST direct_messages/events/new - 1 対 1 の Direct Message を作成します。この v1.1 エンドポイントは 1 対 1 のメッセージのみを作成でき、グループメッセージはサポートしていません。
  • DELETE direct_messages/events/destroy - 認証済みユーザーの視点から 1 対 1 のメッセージを削除します。
この v2 リリースでは、Direct Messages を作成するための POST メソッドが 3 つ用意されています。
  • POST /2/dm_conversations/with/:participant_id/messages - 1 対 1 の Direct Message を作成します。このメソッドは、既存の 1 対 1 の会話にメッセージを追加するか、新しい会話を作成します。:participant_id パスパラメータは、メッセージを受け取るアカウントの User ID です。
  • POST /2/dm_conversations - 新しいグループ会話を作成し、そこに Direct Message を追加します。これらのリクエストには会話参加者のリストが必要です。同じ参加者リストで複数の会話を作成できることに注意してください。これらのリクエストは常に新しい会話 ID を返します。
  • POST /2/dm_conversations/:dm_conversation_id/messages - Direct Message を作成し、既存の会話に追加します。:dm_conversation_id パスパラメータは、メッセージを追加する会話の ID です。
重要な点として、会話 ID とイベント ID は X Platform の v1.1 と v2 間で共有されます。つまり、両バージョンを併用することが可能です。例えば、Direct Messages v1.1 エンドポイントには単一のイベントを返すメソッドやイベントを削除するメソッド(v2 ではまだ利用不可)が用意されており、ID が v1.1 と v2 で共通のため、v2 が返した ID や X アプリケーションの会話 URL に表示される会話 ID を基に v1.1 リクエストを行うことができます。 次の表は、v1.1 と v2 の manage Direct Messages エンドポイントの基本的な側面を比較したものです。ここで示す X API v2 の特徴は、すべての Direct Message lookup エンドポイントに共通しています。 以下の表は、v2 の各 POST メソッドを v1.1 と比較したものです。これらの v2 の機能は、グループ会話をサポートすることで利用可能な機能を拡張していることに注意してください。 新しい 1 対 1 の Direct Message を作成 Path: POST /2/dm_conversations/with/:participant_id/messages 新しい Direct Message グループ会話を作成し、メッセージを追加 Path: POST /2/dm_conversations ID を指定して既存の会話に Direct Message を追加 Path: POST /2/dm_conversations/:dm_conversation_id/messages