查询伙伴角色列表

GET

/v1.0/exclusive/partnerRoles/{parentId}

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口根据父标签ID获取角色列表。

例如，有个伙伴类型名为开放测试，存在角色1，角色1中可见设置为员工小钉（userId为001）、测试部门1（部门ID为1）。角色1的预警设置为员工小钉、测试部门2(部门ID为2)，角色为必邀。

调用本接口后相关信息如图所示，可获取以下信息。

对谁可见中可获取：可见员工列表中的员工小钉的userId为001，可见部门列表中的测试部门1的部门ID为1。

是否必邀角色：角色1是必邀角色。

对谁预警中可获取：预警成员列表中的员工小钉的userId为001，预警部门列表中的测试部门2的部门ID为2。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	伙伴钉部门信息读权限	API Explorer
第三方企业应用	支持	伙伴钉部门信息读权限	API Explorer
第三方个人应用	暂不支持	伙伴钉部门信息读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	param.illegal	参数不合法，请确认parentId是否正确	参数不合法，请确认parentId是否正确

请求参数

Path 参数

Header 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/exclusive/partnerRoles/' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
    "list": [
        {
            "id": 0,
            "name": "string",
            "isNecessary": 0,
            "visibleUsers": [
                {
                    "userId": "string",
                    "name": "string"
                }
            ],
            "visibleDepts": [
                {
                    "deptId": 0,
                    "name": "string"
                }
            ],
            "warningUsers": [
                {
                    "userId": "string",
                    "name": "string"
                }
            ],
            "warningDepts": [
                {
                    "deptId": 0,
                    "name": "string"
                }
            ]
        }
    ]
}

修改于 2024-01-18 06:30:37

修改伙伴类型可见性

修改角色可见性

查询伙伴角色列表

权限#

错误码#

请求参数

返回响应

权限

错误码