Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/role/getrolegroup |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internalappType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_get_department_list-Izin baca untuk informasi 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 untuk mendapatkan access_token Aplikasi internal. - Untuk Aplikasi perusahaan pihak ketiga, dapatkan melalui API untuk mendapatkan access_token organisasi pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| group_id | Number | Ya | 1507113580 | ID grup peran. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/role/getrolegroup" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ab02axxxx7d770' \
-d 'group_id=1'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.setGroupId(1507113580L);
OapiRoleGetrolegroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleGetrolegroupRequest("https://api.dingtalk.io/topapi/role/getrolegroup")
req.group_id=1
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 OapiRoleGetrolegroupRequest;
$req->setGroupId("1");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/getrolegroup");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.GroupId = 1L;
OapiRoleGetrolegroupResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| role_group | OpenRoleGroup | Informasi grup peran. | |
| roles | OpenRole[] | Daftar peran. | |
| role_id | Number | 1507113580 | ID peran. |
| role_name | String | Supervisor | Nama peran. |
| group_name | String | Default | Nama grup peran. |
| errcode | Number | 0 | Kode hasil. |
| errmsg | String | ok | Deskripsi kode hasil. |
| request_id | String | 8lgzequlri0o | ID permintaan. |
Contoh respons
{
"errcode": 0,
"errmsg": "ok",
"role_group": {
"group_name": "Default",
"roles": [
{
"role_name": "Owner",
"role_id": 1507113580
},
{
"role_name": "Supervisor",
"role_id": 1507113581
},
{
"role_name": "Super Admin",
"role_id": 1507113578
},
{
"role_name": "Sub Admin",
"role_id": 1507113579
}
]
},
"request_id": "8lgzequlri0o"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 400002 | Invalid parameter | Verifikasi apakah groupId valid. |
| -1 | System is busy | Coba lagi nanti. |