POST users/report_spam - スパム報告を実行する
公開日:
users/report_spam(POSTメソッド)は、対象ユーザーのスパム報告を実行するエンドポイントです。これを実行した場合、自動的にそのユーザーをブロックします。このエンドポイントはテストで利用しないで下さい。実行したあなた自身がスパムアカウントと判断されてしまう可能性があります。
- POST users/report_spam
- Twitterの公式リファレンス(英語)。users/report_spamに関する説明があります。
リソース
エンドポイント
POST https://api.twitter.com/1.1/users/report_spam.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read and Write | - |
レートリミット | あり(Twitterルールを適用) | - |
パラメータ
user_id
指定例: 1528352858
対象ユーザーのユーザーID。
screen_name
指定例: arayutw
対象ユーザーのスクリーンネーム。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/users/report_spam.json
リクエストヘッダー
Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.86792700+1484904276,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484904276,oauth_token=:access_token,oauth_version=1.0,screen_name=Twitter,oauth_signature=fAEZ0RrSb0aORDqKoZkWS4boi4s%3D
リクエストボディ
screen_name=Twitter
レスポンスボディ (JSON)
JSON
{"id":783214,"id_str":"783214","name":"Twitter","screen_name":"Twitter","location":"San Francisco, CA","description":"Your official source for news, updates, and tips from Twitter, Inc. Need help? Visit https:\/\/t.co\/jTMg7YsLw5.","url":"https:\/\/t.co\/gN5JJwhQy7","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/gN5JJwhQy7","expanded_url":"https:\/\/blog.twitter.com\/","display_url":"blog.twitter.com","indices":[0,23]}]},"description":{"urls":[{"url":"https:\/\/t.co\/jTMg7YsLw5","expanded_url":"https:\/\/support.twitter.com","display_url":"support.twitter.com","indices":[85,108]}]}},"protected":false,"followers_count":58698968,"friends_count":155,"listed_count":90537,"created_at":"Tue Feb 20 14:35:54 +0000 2007","favourites_count":3104,"utc_offset":-28800,"time_zone":"Pacific Time (US & Canada)","geo_enabled":true,"verified":true,"statuses_count":3800,"lang":"en","status":{"created_at":"Fri Jan 20 02:37:02 +0000 2017","id":822271690516238336,"id_str":"822271690516238336","text":"@Menley897 Your positivity is contagious, we can\u2019t stop smiling. \ud83e\udd17","truncated":false,"entities":{"hashtags":[],"symbols":[],"user_mentions":[{"screen_name":"Menley897","name":"MENLEY","id":727012025717547012,"id_str":"727012025717547012","indices":[0,10]}],"urls":[]},"source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","in_reply_to_status_id":822172609718562816,"in_reply_to_status_id_str":"822172609718562816","in_reply_to_user_id":727012025717547012,"in_reply_to_user_id_str":"727012025717547012","in_reply_to_screen_name":"Menley897","geo":null,"coordinates":null,"place":null,"contributors":null,"is_quote_status":false,"retweet_count":0,"favorite_count":7,"favorited":false,"retweeted":false,"lang":"en"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"ACDED6","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/657090062\/l1uqey5sy82r9ijhke1i.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/657090062\/l1uqey5sy82r9ijhke1i.png","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/767879603977191425\/29zfZY6I_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/767879603977191425\/29zfZY6I_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/783214\/1484699793","profile_link_color":"226699","profile_sidebar_border_color":"FFFFFF","profile_sidebar_fill_color":"F6F6F6","profile_text_color":"333333","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false,"muting":false,"translator_type":"regular"}
レスポンスヘッダー
HTTP/1.1 200 OK
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-disposition: attachment; filename=json.json
content-length: 2838
content-type: application/json;charset=utf-8
date: Fri, 20 Jan 2017 09:24:37 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Fri, 20 Jan 2017 09:24:37 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148490427694299006; Domain=.twitter.com; Path=/; Expires=Sun, 20-Jan-2019 09:24:37 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read-write
x-connection-hash: 79e6429a693d970fb730e4778310cf83
x-content-type-options: nosniff
x-frame-options: DENY
x-response-time: 224
x-transaction: 006e38fe00b6a376
x-tsa-request-body-time: 0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
users/report_spamのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
users/report_spamのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[POST users/report_spam]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/post/users/report_spam
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/users/report_spam/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/users/report_spam.json' ; // エンドポイント
$request_method = 'POST' ;
// パラメータA (オプション)
$params_a = array(
"user_id" => "",
// "screen_name" => "",
) ;
// キーを作成する (URLエンコードする)
$signature_key = rawurlencode( $api_secret ) . '&' . rawurlencode( $access_token_secret ) ;
// パラメータB (署名の材料用)
$params_b = array(
'oauth_token' => $access_token ,
'oauth_consumer_key' => $api_key ,
'oauth_signature_method' => 'HMAC-SHA1' ,
'oauth_timestamp' => time() ,
'oauth_nonce' => microtime() ,
'oauth_version' => '1.0' ,
) ;
// パラメータAとパラメータBを合成してパラメータCを作る
$params_c = array_merge( $params_a , $params_b ) ;
// 連想配列をアルファベット順に並び替える
ksort( $params_c ) ;
// パラメータの連想配列を[キー=値&キー=値...]の文字列に変換する
$request_params = http_build_query( $params_c , '' , '&' ) ;
// 一部の文字列をフォロー
$request_params = str_replace( array( '+' , '%7E' ) , array( '%20' , '~' ) , $request_params ) ;
// 変換した文字列をURLエンコードする
$request_params = rawurlencode( $request_params ) ;
// リクエストメソッドをURLエンコードする
// ここでは、URL末尾の[?]以下は付けないこと
$encoded_request_method = rawurlencode( $request_method ) ;
// リクエストURLをURLエンコードする
$encoded_request_url = rawurlencode( $request_url ) ;
// リクエストメソッド、リクエストURL、パラメータを[&]で繋ぐ
$signature_data = $encoded_request_method . '&' . $encoded_request_url . '&' . $request_params ;
// キー[$signature_key]とデータ[$signature_data]を利用して、HMAC-SHA1方式のハッシュ値に変換する
$hash = hash_hmac( 'sha1' , $signature_data , $signature_key , TRUE ) ;
// base64エンコードして、署名[$signature]が完成する
$signature = base64_encode( $hash ) ;
// パラメータの連想配列、[$params]に、作成した署名を加える
$params_c['oauth_signature'] = $signature ;
// パラメータの連想配列を[キー=値,キー=値,...]の文字列に変換する
$header_params = http_build_query( $params_c , '' , ',' ) ;
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => $request_method , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: OAuth ' . $header_params ,
) ,
) ,
) ;
// パラメータがある場合、URLの末尾に追加 (POSTの場合は不要)
// if ( $params_a ) {
// $request_url .= '?' . http_build_query( $params_a ) ;
// }
// オプションがある場合、コンテキストにPOSTフィールドを作成する
if ( $params_a ) {
$context['http']['content'] = http_build_query( $params_a ) ;
}
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl, CURLOPT_URL , $request_url ) ;
curl_setopt( $curl, CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl, CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl, CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl, CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
if( isset( $context['http']['content'] ) && !empty( $context['http']['content'] ) ) {
curl_setopt( $curl , CURLOPT_POSTFIELDS , $context['http']['content'] ) ; // リクエストボディ
}
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = @file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換 (処理する場合)
// $obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">POST users/report_spam</h1>' ;
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
$html .= '<h3>ボディ</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . ( isset($context['http']['content']) ? $context['http']['content'] : "" ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/Web/API/Twitter/REST_API/POST/users/report_spam/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;