メインコンテンツへスキップ
Manage DM blocks エンドポイントは、認証済みユーザーに代わって指定したアカウントをブロックまたはブロック解除するための機能を提供します。これらのエンドポイントには、2つの POST メソッドがあります。
  • /2/users/:id/dm/block: アカウントをブロックします
  • /2/users/:id/dm/unblock: アカウントのブロックを解除します

はじめに

認証

ユーザーに代わってリクエストを行う場合は、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 認可コード(PKCE 対応)でこれらのエンドポイントを認証し、対象ユーザーに紐づくユーザー Access Token を必ず使用してください。ユーザー Access Token は、3-legged OAuth フロー(OAuth 1.0a)または Authorization Code with PKCE フロー(OAuth 2.0)で生成できます。

リクエストの送信

ブロック ユーザーがあなたのアプリで認証を済ませたら、以下のとおりユーザーに代わって Block エンドポイントを呼び出せます。
      curl --request POST 'https://api.x.com/2/users/:id/dm/block' --header 'Authorization: ••••••'
リクエストが成功すると、以下のような JSON レスポンスが表示されます。
{
   "data": {
       "blocked": true
   }
}
ブロック解除 ユーザーがアプリで認証を完了すると、以下のように、そのユーザーに代わって Unblock エンドポイントを呼び出せます。
      curl --request POST 'https://api.x.com/2/users/:id/dm/unblock' --header 'Authorization: ••••••'
リクエストが成功すると、次のような JSON レスポンスが表示されます。
{
   "data": {
       "blocked": false
   }
}