跳转到主要内容
调用本接口,获取角色组信息。

请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/role/getrolegroup
HTTP MethodPOST
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_get_department_list-通讯录部门信息读权限

查询参数

名称类型是否必填示例值描述
access_tokenStringbE74xxxx调用该API的应用凭证。 - 企业内部应用,通过获取企业内部应用的access_token接口获取。 - 第三方企业应用,通过获取第三方企业的access_token接口获取。

请求体

名称类型是否必填示例值描述
group_idNumber1507113580角色组的ID。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/role/getrolegroup" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ab02axxxx7d770' \
-d 'group_id=1'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.setGroupId(1507113580L);
OapiRoleGetrolegroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiRoleGetrolegroupRequest("https://oapi.dingtalk.io/topapi/role/getrolegroup")

req.group_id=1
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP
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://oapi.dingtalk.io/topapi/role/getrolegroup");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.GroupId = 1L;
OapiRoleGetrolegroupResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
role_groupOpenRoleGroup角色组信息。
rolesOpenRole[]角色列表信息。
role_idNumber1507113580角色ID。
role_nameString主管角色名。
group_nameString默认角色组名。
errcodeNumber0返回码。
errmsgStringok返回码描述。
request_idString8lgzequlri0o请求ID。

响应体示例

{
  "errcode": 0,
  "errmsg": "ok",
  "role_group": {
    "group_name": "默认",
    "roles": [
      {
        "role_name": "负责人",
        "role_id": 1507113580
      },
      {
        "role_name": "主管",
        "role_id": 1507113581
      },
      {
        "role_name": "主管理员",
        "role_id": 1507113578
      },
      {
        "role_name": "子管理员",
        "role_id": 1507113579
      }
    ]
  },
  "request_id": "8lgzequlri0o"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errcode)错误码描述(errmsg)解决方案
400002无效的参数请检验groupId是否合法
-1系统繁忙请稍后再试