Panduan pengembangPermintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/role/list |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal, appType-Aplikasi perusahaan pihak ketiga |
| Izin | permission-qyapi_get_department_list-Izin baca untuk informasi departemen Kontak |
Parameter query
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | 6ed1bxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan melalui API untuk mendapatkan access_token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan melalui API untuk mendapatkan access_token perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| size | Number | Tidak | 20 | Mendukung query berhalaman. Berlaku hanya jika disetel bersama parameter offset. Parameter ini merepresentasikan ukuran halaman. Default adalah 20. Maksimum adalah 200. |
| offset | Number | Tidak | 0 | Mendukung query berhalaman. Berlaku hanya jika disetel bersama parameter size. Parameter ini merepresentasikan offset, yang dimulai dari 0. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/role/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a0a639xxxx2998' \
-d 'offset=0' \
-d 'size=20'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/list");
OapiRoleListRequest req = new OapiRoleListRequest();
req.setSize(20L);
req.setOffset(0L);
OapiRoleListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleListRequest("https://api.dingtalk.io/topapi/role/list")
req.size=20
req.offset=0
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 OapiRoleListRequest;
$req->setSize("20");
$req->setOffset("0");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/list");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/list");
OapiRoleListRequest req = new OapiRoleListRequest();
req.Size = 20L;
req.Offset = 0L;
OapiRoleListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | ii8a42qgzu7e | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| result | PageVo | Daftar hasil. | |
| hasMore | Boolean | false | Apakah tersedia lebih banyak data. |
| list | OpenRoleGroup[] | Daftar grup peran. | |
| name | String | Default | Nama grup peran. |
| groupId | Number | 1507113577 | ID grup peran. |
| roles | OpenRole[] | Daftar peran. | |
| name | String | Admin | Nama peran. |
| id | Number | 1507113578 | ID peran. |
Contoh isi respons
{
"errcode": 0,
"result": {
"hasMore": true,
"list": [
{
"groupId": 1507113577,
"name": "Default",
"roles": [
{
"id": 1507113580,
"name": "Owner"
},
{
"id": 1507113581,
"name": "Manager"
},
{
"id": 1507113578,
"name": "Super Admin"
},
{
"id": 1507113579,
"name": "Sub Admin"
}
]
}
]
},
"request_id": "ii8a42qgzu7e"
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 400043 | Invalid orgId | Periksa apakah access_token sudah benar. |
| 40069 | Invalid size | Sesuaikan ukuran halaman. |
| 40068 | Invalid offset | Sesuaikan offset. |
| 400001 | System error | Coba lagi nanti. |