跳转到主要内容
调用本接口，创建新角色。 新增角色

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/role/add_role
HTTP MethodPOST
支持的应用类型appType-企业内部应用
权限要求permission-qyapi_manage_addresslist-通讯录数据管理权限

​
查询参数

名称类型是否必填示例值描述
access_tokenString是6d1bxxxx调用该接口的应用凭证，通过获取企业内部应用的access_token接口获取。

​
请求体

名称类型是否必填示例值描述
roleNameString是服务角色名称。
groupIdNumber是1507113595角色组ID。 - 如果要加入的角色组已存在，调用获取角色列表接口获取。 - 如果尚未创建角色组，先调用创建角色组接口创建角色组，并获取角色组ID。

​
请求示例

curl -X POST "https://oapi.dingtalk.io/role/add_role" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2e3f55xxxx6e34' \
-d 'groupId=11' \
-d 'roleName=test'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/role/add_role");
OapiRoleAddRoleRequest req = new OapiRoleAddRoleRequest();
req.setRoleName("测试1");
req.setGroupId(1507113595L);
OapiRoleAddRoleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

req=dingtalk.api.OapiRoleAddRoleRequest("https://oapi.dingtalk.io/role/add_role")

req.roleName="test"
req.groupId=11
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 OapiRoleAddRoleRequest;
$req->setRoleName("test");
$req->setGroupId("11");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/role/add_role");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/role/add_role");
OapiRoleAddRoleRequest req = new OapiRoleAddRoleRequest();
req.RoleName = "test";
req.GroupId = 11L;
OapiRoleAddRoleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
roleIdNumber1688611118角色ID。
errcodeNumber0返回码。
errmsgStringok返回码描述。

​
响应体示例

{
  "errcode":0,
  "roleId":1688611118,
  "errmsg":"ok"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。
错误码（errcode）错误码描述（errmsg）解决方案
34018角色不能为空请填上roleName和groupId
34020无效的groupId请检查groupId是否正确
34021角色名称已存在请检查roleName是否正确
-1系统繁忙请稍后再试