跳转到主要内容
调用本接口,根据角色ID删除指定的角色。

接口调用说明

  • 在调用该接口前,确保与要删除的角色关联的员工都已删除该角色。
  • 不允许删除默认角色组下的角色。

请求

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

查询参数

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

请求体

名称类型是否必填示例值描述
role_idNumber1581321999要删除的角色ID,可以调用获取角色列表接口获取。 “默认”分组内的角色不支持修改,包括:负责人、主管、主管理员、子管理员

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/role/deleterole" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f5326exxxxbe8d071' \
-d 'role_id=11'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/deleterole");
OapiRoleDeleteroleRequest req = new OapiRoleDeleteroleRequest();
req.setRoleId(1581321999L);
OapiRoleDeleteroleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiRoleDeleteroleRequest("https://oapi.dingtalk.io/topapi/role/deleterole")

req.role_id=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 OapiRoleDeleteroleRequest;
$req->setRoleId("11");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/role/deleterole");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/role/deleterole");
OapiRoleDeleteroleRequest req = new OapiRoleDeleteroleRequest();
req.RoleId = 11L;
OapiRoleDeleteroleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
errcodeNumber0返回码。
errmsgStringok返回码描述。
request_idStringzw9fhpj3m32u请求ID。

响应体示例

{
  "errcode":"0",
  "request_id":"zw9fhpj3m32u"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errcode)错误码描述(errmsg)解决方案
33011无效的role_id请校验role_id是否正确
23004不允许编辑系统标签请校验role_id是否合法
1002系统繁忙请稍后再试