获取员工花名册字段信息

说明

调用本接口查询员工花名册指定字段的信息，支持明细分组字段。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考接口权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

af21xxx

Body 参数application/json

userid_list

string

必需

员工的userid列表，多个userid之间使用逗号分隔，一次最多支持传100个值。

field_filter_list

string

可选

需要获取的花名册字段信息。查询字段越少，RT越低，建议按需查询，多个字段之间使用逗号分隔，一次最多支持传100个值。此值不传时：企业内部应用调用获取全部字段。第三方企业应用获取所有有权限的字段。

agentid

number

必需

应用的AgentID。企业内部应用可在开发者后台的应用详情页获取应用ID。第三方企业应用可调用获取授权应用的基本信息接口获取。

示例

{
  "agentid": 957064202,
  "userid_list": "user123,user456",
  "field_filter_list": "sys01-positionLevel,sys05-nowContractEndTime"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

array [object {3}]

返回结果。

可选

corp_id

string

可选

企业的corpid。

field_data_list

array [object {4}]

可选

返回的字段信息列表。

userid

string

可选

员工的userid。

success

boolean

调用是否成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
  "result": [
    {
      "corp_id": "string",
      "field_data_list": [
        {
          "field_name": "string",
          "field_code": "string",
          "group_id": "string",
          "field_value_list": [
            {
              "item_index": 0,
              "label": "string",
              "value": "string"
            }
          ]
        }
      ],
      "userid": "string"
    }
  ],
  "success": true,
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}

获取员工花名册字段信息

说明#

权限#

请求参数

示例代码

返回响应

说明

权限