印刷する

ユーザー:ユーザーグループ

users > list_user_groups

ユーザーグループの一覧を取得します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数説明
gousersAPIセクション
dolist_user_groupsAPIアクション

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=list_user_groups&{required information}
POST変数

このリクエストにはPOST変数は必要ありません。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
list:ユーザーグループリストを持つ配列(配列は空の場合もあります)。
配列には以下が含まれます。

  • id:グループID(整数)
  • title:グループのタイトル/名前(文字列)
{
	"list": [{
		"id": "1",
		"title": "Group 1"
	}, {
		"id": "2",
		"title": "Group 2"
	}]
}

リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Missing signature"
}

エラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "list_user_groups"
					);

// POST変数
$POST_VARS = array();