SYNCER

SYNCER

POST lists/subscribers/create - リストを保存する

9件

公開日:

lists/subscribers/create(POSTメソッド)は、対象のリストを保存するエンドポイントです。

POST lists/subscribers/create
POST lists/subscribers/create
Twitterの公式リファレンス(英語)。lists/subscribers/createに関する説明があります。

リソース

エンドポイント

POST https://api.twitter.com/1.1/lists/subscribers/create.json

条件

項目ユーザー認証アプリケーション認証
利用×
パーミッションRead and Write-
レートリミットあり(Twitterルールを適用)-

パラメータ

list_id

指定例: 198828364

対象のリストの、リストID。

slug

指定例: developers

対象のリストの、スラッグ。owner_screen_name、またはowner_idと併せて指定する必要がある。

owner_screen_name

指定例: arayutw

リストのオーナー(作成者)の、スクリーンネーム。slugでリストを指定する場合に必要。

owner_id

指定例: 1528352858

リストのオーナー(作成者)の、ユーザーID。slugでリストを指定する場合に必要。

レスポンス

アクセストークン(OAuth1.0)でリクエストをした場合の例です。

リクエストURL

https://api.twitter.com/1.1/lists/subscribers/create.json

リクエストヘッダー

Authorization: OAuth list_id=198828364,oauth_consumer_key=:consumer_key,oauth_nonce=0.30540200+1484893712,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484893712,oauth_token=:access_token,oauth_version=1.0,oauth_signature=Tol1D%2BgPITpVoeKBqtwj5%2B0Kypo%3D

リクエストボディ

list_id=198828364

レスポンスボディ (JSON)

JSON

{"id":198828364,"id_str":"198828364","name":"SYNCER","uri":"\/SyncerJP\/lists\/syncer1","subscriber_count":1,"member_count":2,"mode":"public","description":"SYNCER\u304c\u904b\u7528\u3059\u308b\u30a2\u30ab\u30a6\u30f3\u30c8\u306e\u30ea\u30b9\u30c8\u3067\u3059\u3002","slug":"syncer1","full_name":"@SyncerJP\/syncer1","created_at":"Sat Mar 14 16:25:36 +0000 2015","following":false,"user":{"id":2905085521,"id_str":"2905085521","name":"SYNCER","screen_name":"SyncerJP","location":"Tokyo","description":"\u30d6\u30ed\u30b0\u300cSYNCER\u300d\u306e\u30a2\u30ab\u30a6\u30f3\u30c8\u3067\u3059\u3002\u8a18\u4e8b\u306b\u8a00\u53ca\u3057\u3066\u304f\u308c\u305f\u30c4\u30a4\u30fc\u30c8\u3092\u304a\u6c17\u306b\u5165\u308a\u767b\u9332\u3057\u305f\u308a\u3057\u307e\u3059\u3002 \u6700\u7d42\u66f4\u65b0\u65e5:2015\/05\/22","url":"https:\/\/t.co\/J5bOOK7ugS","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/J5bOOK7ugS","expanded_url":"https:\/\/syncer.jp","display_url":"syncer.jp","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":267,"friends_count":2,"listed_count":10,"created_at":"Thu Nov 20 11:17:51 +0000 2014","favourites_count":1618,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":false,"statuses_count":643,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"000000","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/2905085521\/1432005636","profile_link_color":"D36015","profile_sidebar_border_color":"C6E2EE","profile_sidebar_fill_color":"DAECF4","profile_text_color":"663B12","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":true,"follow_request_sent":false,"notifications":false,"translator_type":"none"}}

レスポンスヘッダー

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: 2313
content-type: application/json;charset=utf-8
date: Fri, 20 Jan 2017 06:28:32 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Fri, 20 Jan 2017 06:28:32 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148489371237787183; Domain=.twitter.com; Path=/; Expires=Sun, 20-Jan-2019 06:28:32 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read-write
x-connection-hash: bf19754f67f1ccb8b36664524138b606
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-response-time: 189
x-transaction: 009651090004fbba
x-tsa-request-body-time: 0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block

デモ

lists/subscribers/createのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。

list_id

slug

owner_screen_name

owner_id

認証方法 (ユーザー認証のみ)

/

サンプルコード

lists/subscribers/createのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$jsonという変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。

アクセストークン

PHP (OAuth1.0)

<?php
/**************************************************

	[POST lists/subscribers/create]のお試しプログラム

	認証方式: アクセストークン

	配布: SYNCER
	公式ドキュメント: https://dev.twitter.com/rest/reference/post/lists/subscribers/create
	日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/lists/subscribers/create/

**************************************************/

	// 設定
	$api_key = '' ;	// APIキー
	$api_secret = '' ;	// APIシークレット
	$access_token = '' ;	// アクセストークン
	$access_token_secret = '' ;	// アクセストークンシークレット
	$request_url = 'https://api.twitter.com/1.1/lists/subscribers/create.json' ;	// エンドポイント
	$request_method = 'POST' ;

	// パラメータA (オプション)
	$params_a = array(
		"list_id" => "198828364",
//		"slug" => "developers",
//		"owner_screen_name" => "arayutw",
//		"owner_id" => "1528352858",
	) ;

	// キーを作成する (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 lists/subscribers/create</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/lists/subscribers/create/" target="_blank">SYNCER</a></small>' ;

	// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
	echo $html ;