API 呼び出し説明
- 本 API は社員の userId と name の 2 つのフィールド情報のみ取得できます。部門配下の社員詳細情報を取得する場合は、部門ユーザーの詳細情報を取得を参照してください。
- 本 API は現在の部門内の社員ベーシック情報のみ取得できます。子部門内の社員情報は取得できません。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/user/listsimple |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリappType-サードパーティ社内アプリ |
| 権限要件 | permission-qyapi_get_department_member-連絡先部門メンバー読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API を呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token を取得する API から取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token を取得する API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| dept_id | Number | はい | 10 | 部門 ID。ルート部門の場合は 1 を指定します。部門リストを取得 を呼び出して dept_id の値を取得できます。 |
| cursor | Number | はい | 0 | ページネーションクエリのカーソル。最初は 0 を指定し、以降はレスポンスパラメータの next_cursor の値を指定します。 |
| size | Number | はい | 10 | ページサイズ。最大値は 100。 |
| order_field | String | いいえ | modify_desc | 部門メンバーの並べ替えルール。デフォルト値は custom。 - entry_asc:部門への加入時間の昇順。 - entry_desc:部門への加入時間の降順。 - modify_asc:部門情報の編集時間の昇順。 - modify_desc:部門情報の編集時間の降順。 - custom:ユーザー定義順(未定義の場合はピンイン順)。 |
| contain_access_limit | Boolean | いいえ | false | アクセス制限のある社員を返すかどうか。 - true:はい - false:いいえ |
| language | String | いいえ | zh_CN | 連絡先の言語。 - zh_CN:中国語(デフォルト)。 - en_US:英語。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/user/listsimple" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c1f2d110-4e7c-4536-a340-06652613e0c1' \
-d 'contain_access_limit=false' \
-d 'cursor=0' \
-d 'dept_id=10' \
-d 'language=zh_CN' \
-d 'order_field=modify_desc' \
-d 'size=10'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/listsimple");
OapiUserListsimpleRequest req = new OapiUserListsimpleRequest();
req.setDeptId(10L);
req.setCursor(0L);
req.setSize(10L);
req.setOrderField("modify_desc");
req.setContainAccessLimit(false);
req.setLanguage("zh_CN");
OapiUserListsimpleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiUserListsimpleRequest("https://api.dingtalk.io/topapi/user/listsimple")
req.dept_id=10
req.cursor=0
req.size=10
req.order_field="modify_desc"
req.contain_access_limit=false
req.language="zh_CN"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiUserListsimpleRequest;
$req->setDeptId("10");
$req->setCursor("0");
$req->setSize("10");
$req->setOrderField("modify_desc");
$req->setContainAccessLimit("false");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/user/listsimple");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/listsimple");
OapiUserListsimpleRequest req = new OapiUserListsimpleRequest();
req.DeptId = 10L;
req.Cursor = 0L;
req.Size = 10L;
req.OrderField = "modify_desc";
req.ContainAccessLimit = false;
req.Language = "zh_CN";
OapiUserListsimpleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | 4f9md9obopn2 | リクエスト ID。 |
| errcode | Number | 0 | 戻りコード。0 は成功を表します。 |
| errmsg | String | ok | 戻りコードの説明。 |
| result | PageResult | 戻り結果。 | |
| has_more | Boolean | true | さらにデータがあるかどうか。 - true:はい - false:いいえ |
| next_cursor | Number | 10 | 次のページネーションのカーソル。has_more が false の場合、これ以上のページネーションデータはないことを示します。 |
| list | ListUserSimpleResponse[] | ユーザー情報リスト。 | |
| userid | String | zxxxxx | ユーザーの userid。 |
| name | String | 山田太郎 | ユーザー名。 |
レスポンスボディ例
{
"errcode": 0,
"errmsg": "ok",
"result": {
"has_more": false,
"list": [
{
"name": "テストユーザー2",
"userid": "user100"
},
{
"name": "佐藤花子",
"userid": "user1"
}
]
},
"request_id": "x4p6arvi0fzj"
}
エラーコード
API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索できます。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 400002 | 無効なパラメータ | パラメータが上記の要件どおりに入力されているか確認してください |
| 60003 | 対応する部門が見つかりません | 部門 ID が正しいか確認してください |
| 40069 | 無効な size | ページサイズを調整してください |
| 40068 | 無効なオフセット | オフセットを調整してください |
| -1 | システムビジー | 後でもう一度お試しください |