跳转到主要内容
调用本接口根据用户的userid删除指定用户。

接口调用说明

调用本接口成功删除通讯录员工,同时会删除以下内容:
  • 该员工所在的考勤组会同步删除该员工。
  • 智能人事花名册会同步删除该员工,员工信息可以在智能人事已离职人员中查看。

请求

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

查询参数

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

请求体

名称类型是否必填示例值描述
useridStringuxxxx3员工的userid。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/v2/user/delete" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0b8a6220-ef56-4427-83d5-5690431776e5' \
-d 'userid=zhangsan'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/v2/user/delete");
OapiV2UserDeleteRequest req = new OapiV2UserDeleteRequest();
req.setUserid("user123");
OapiV2UserDeleteResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiV2UserDeleteRequest("https://oapi.dingtalk.io/topapi/v2/user/delete")

req.userid="zhangsan"
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 OapiV2UserDeleteRequest;
$req->setUserid("zhangsan");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/v2/user/delete");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/v2/user/delete");
OapiV2UserDeleteRequest req = new OapiV2UserDeleteRequest();
req.Userid = "zhangsan";
OapiV2UserDeleteResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
request_idString4f9md9obopn2请求ID。
errcodeNumber0返回码。
errmsgString不合法的userid调用失败时返回的错误信息。

响应体示例

{
  "errcode": 0,
  "errmsg": "ok",
  "request_id": "4f9md9obopn2"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errcode)错误码描述(errmsg)解决方案
33012无效的 userId请检查 userId 是否正确
400002无效的参数请确认参数是否按要求输入
-1系统繁忙请稍后再试