dingtalk.oapi.kac.datav.inactivated.user.list (查询大客户通讯录未激活用户列表)

大客户钉钉数据:查询当前企业当前通讯录未激活明细列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request UnactivatedUserRequest 必须 请求参数对象
  • └ data_id
  • String
  • 必须
  • 20200501
  • 日期标识
  • └ size
  • Number
  • 必须
  • 10
  • 分页大小;不超过100
  • └ cursor
  • Number
  • 必须
  • 0
  • 分页游标;首页请使用0,之后直接使用返回结果中的next_cursor

响应参数

名称 类型 示例值 描述
errcode Number 0 结果码
errmsg String 成功 提示信息
result UnactivatedUserResponse result 结果对象
  • data
  • UnactivatedUserVo []
  • data
  • 人员列表
  • └ dept_id
  • Number
  • 1
  • 部门id
  • └ dept_name
  • String
  • 技术部
  • 部门名称
  • └ userid
  • String
  • 123
  • 员工在当前企业内的唯一标识,也称staffId。可由企业在创建时指定,并代表一定含义比如工号,创建后不可修改
  • └ staff_job_num
  • String
  • 101
  • 员工工号
  • └ staff_name
  • String
  • 王小毛
  • 员工姓名
  • └ has_more
  • Boolean
  • true
  • 是否有下一页;true则存在更多分页
  • └ next_cursor
  • Number
  • 10002
  • 下一次请求的分页游标

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/inactivated/user/list");
OapiKacDatavInactivatedUserListRequest req = new OapiKacDatavInactivatedUserListRequest();
UnactivatedUserRequest obj1 = new UnactivatedUserRequest();
obj1.setDataId("20200501");
obj1.setSize(10L);
obj1.setCursor(0L);
req.setRequest(obj1);
OapiKacDatavInactivatedUserListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
{
    "errcode":0,
    "errmsg":"成功",
    "result":{
        "data":[
            {
                    "dept_id":1,
                    "dept_name":"技术部",
                    "userid":"123",
                    "staff_job_num":"101",
                    "staff_name":"王小毛"
            }
        ],
        "has_more":true,
        "next_cursor":10002
    }
}

异常示例

  • JSON示例
{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部