Deskripsi panggilan API
- API ini hanya mengembalikan field userId dan name dari pengguna. Untuk mendapatkan informasi pengguna yang lebih detail, lihat Mendapatkan informasi lengkap pengguna departemen.
- API ini hanya mengembalikan informasi dasar pengguna di departemen saat ini. Informasi pengguna di sub-departemen tidak dikembalikan.
Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/user/listsimple |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin | permission-qyapi_get_department_member-Izin baca untuk pengguna departemen Kontak |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan melalui API yang mendapatkan access_token dari aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan melalui API yang mendapatkan access_token dari perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| dept_id | Number | Ya | 10 | ID departemen. Untuk departemen root, gunakan 1. Panggil Mendapatkan daftar departemen untuk mendapatkan nilai dept_id. |
| cursor | Number | Ya | 0 | Cursor untuk paginasi. Gunakan 0 untuk permintaan pertama, dan gunakan nilai next_cursor dari respons pada permintaan berikutnya. |
| size | Number | Ya | 10 | Ukuran halaman. Nilai maksimum adalah 100. |
| order_field | String | Tidak | modify_desc | Aturan pengurutan untuk pengguna departemen. Nilai default adalah custom. - entry_asc: urutkan berdasarkan waktu bergabung ke departemen secara menaik. - entry_desc: urutkan berdasarkan waktu bergabung ke departemen secara menurun. - modify_asc: urutkan berdasarkan waktu modifikasi informasi departemen secara menaik. - modify_desc: urutkan berdasarkan waktu modifikasi informasi departemen secara menurun. - custom: pengurutan yang ditentukan pengguna (diurutkan berdasarkan pinyin jika tidak ditentukan). |
| contain_access_limit | Boolean | Tidak | false | Apakah akan mengembalikan pengguna dengan akses terbatas. - true: Ya - false: Tidak |
| language | String | Tidak | zh_CN | Bahasa Kontak. - zh_CN: Bahasa Tionghoa (default). - en_US: Bahasa Inggris. |
Contoh permintaan
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.Language = "zh_CN";
req.ContainAccessLimit = false;
req.Language = "zh_CN";
OapiUserListsimpleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | 4f9md9obopn2 | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. 0 menunjukkan berhasil. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| result | PageResult | Hasil yang dikembalikan. | |
| has_more | Boolean | true | Apakah tersedia data lebih lanjut. - true: Ya - false: Tidak |
| next_cursor | Number | 10 | Cursor untuk halaman berikutnya. Jika has_more bernilai false, tidak ada lagi data paginasi yang tersedia. |
| list | ListUserSimpleResponse[] | Daftar informasi pengguna. | |
| userid | String | zxxxxx | userid dari pengguna. |
| name | String | Zhang San | Nama pengguna. |
Contoh isi respons
{
"errcode": 0,
"errmsg": "ok",
"result": {
"has_more": false,
"list": [
{
"name": "Pengguna Uji 2",
"userid": "user100"
},
{
"name": "Li Si",
"userid": "user1"
}
]
},
"request_id": "x4p6arvi0fzj"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 400002 | Invalid parameter | Pastikan parameter diisi sesuai persyaratan di atas. |
| 60003 | The department is not found | Pastikan ID departemen sudah benar. |
| 40069 | Invalid size | Sesuaikan ukuran halaman. |
| 40068 | Invalid offset | Sesuaikan offset. |
| -1 | System busy | Coba lagi nanti. |