获取花名册元数据

说明

调用本接口获取员工花名册的元数据，包括花名册分组、字段等。
服务地址：https://oapi.dingtalk.com

权限

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

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

请求参数

Query 参数

access_token

string

必需

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

示例值:

af21axxx

Body 参数application/json

agentid

number

必需

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

示例

{
    "agentid": "123456"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

array [object {4}]

可选

返回结果，花名册分组定义。

group_name

string

分组名称。

可选

group_id

string

分组标识。

可选

field_meta_info_list

array [object {3}]

可选

花名册分组内字段定义。

detail

boolean

分组是否支持明细。

可选

success

boolean

服务调用是否成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
    "result": [
        {
            "group_name": "string",
            "group_id": "string",
            "field_meta_info_list": [
                {
                    "field_name": "string",
                    "field_code": "string",
                    "derived": true
                }
            ],
            "detail": true
        }
    ],
    "success": true,
    "errcode": 0,
    "errmsg": "string",
    "request_id": "string"
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限