概要

DM ブロック管理エンドポイントを使用すると、認証済みユーザーに代わり、指定したアカウントをブロックまたはブロック解除できます。これらのエンドポイントでは、2 つの POST メソッドを利用できます。

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

はじめに

認証

ユーザーを代表してリクエストを送信する場合は、OAuth 1.0a User Context または OAuth 2.0 Authorization Code with PKCE のいずれかでこれらのエンドポイントに対する認証を行い、リクエスト対象のユーザーに紐づくユーザー Access Token を利用する必要があります。ユーザー Access Token は、3-legged OAuth flow (OAuth 1.0a) または Authorization Code with PKCE grant flow (OAuth 2.0) を利用して生成できます。

リクエストの送信

ブロック

ユーザーが App で認証を完了すると、以下のようにそのユーザーを代表して Block エンドポイントを呼び出すことができます。

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

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

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

Unblock

ユーザーがあなたのAppで認証を行ったら、以下のようにそのユーザーに代わって Unblock エンドポイントを呼び出すことができます。

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

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

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