Introduction

manage DM blocks の endpoint を使うと、認証済みユーザーに代わって指定したアカウントをブロックまたはブロック解除できます。これらの endpoint には、次の2つの POST メソッドがあります。

• /2/users/:id/dm/block: アカウントをブロックします
• /2/users/:id/dm/unblock: アカウントのブロックを解除します

​

はじめに

​

認証

ユーザーを代表してリクエストを行う場合、これらのendpointは OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 Authorization Code（PKCE 付き） のいずれかで認証し、対象ユーザーに紐づくユーザーの Access Tokens を使用する必要があります。ユーザーの Access Token は、3-legged OAuth フロー（OAuth 1.0a）または Authorization Code with PKCE grant フロー（OAuth 2.0）を用いて生成できます。

​

リクエストの送信

ブロック

ユーザーがあなたのAppで認証を完了すると、以下のとおりユーザーに代わって Block endpoint を呼び出せます。

      curl --request POST 'https://api.x.com/2/users/:id/dm/block' --header 'Authorization: ••••••'

リクエストが成功すると、次のようなJSONレスポンスが表示されます。

{
   "data": {
       "blocked": true
   }
}

Unblock

ユーザーがあなたのAppで認証を完了すると、以下のとおり、そのユーザーに代わって Unblock endpoint を呼び出せます。

      curl --request POST 'https://api.x.com/2/users/:id/dm/unblock' --header 'Authorization: ••••••'

リクエストが成功すると、以下のとおりJSONレスポンスが表示されます。

{
   "data": {
       "blocked": false
   }
}