钉钉开发文档

应用管理

更新时间: 2019-3-15

获取应用列表

如果希望在企业自定义工作台中添加钉钉原生应用(如审批、日志等)或已上架的第三方应用,可参考在工作台中添加应用

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/microapp/list?access_token=ACCESS_TOKEN
SDK请求示例(JAVA)

DefaultDingTalkClient  client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/list");
OapiMicroappListRequest req = new OapiMicroappListRequest();
OapiMicroappListResponse response = client.execute(req,accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "appList": [
        {
            "appIcon": "http://static.dingtalk.com/media/szIzMg_200_200.png",
            "agentId": 111,
            "appDesc": "应用描述",
            "isSelf": true,
            "name": "应用名称",
            "homepageLink": "http://oa.dingtalk.com/?h5",
            "pcHomepageLink": "http://oa.dingtalk.com/?pc",
            "appStatus": 1,
            "ompLink": "http://oa.dingtalk.com/index"
        }
}
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
appIcon
应用图标
agentId
应用实例化id
appDesc
应用描述
isSelf
表示是否是自建应用
name
应用名称
homepageLink
应用的移动端主页
pcHomepageLink
应用的pc端主页
appStatus
应用状态,
1表示启用
0表示停用
ompLink
应用的OA后台管理主页

获取员工可见的应用列表

如果希望在企业自定义工作台中添加钉钉原生应用(如审批、日志等)或已上架的第三方应用,只需将文字、图标或按钮的对应的跳转url设置为:
dingtalk://dingtalkclient/action/switchtab?index=2&name=work&scene=1&corpid=<企业corpid>&agentid=<跳转到应用的agentid>

请求方式:GET(HTTPS)
请求地址https://oapi.dingtalk.com/microapp/list_by_userid?access_token=ACCESS_TOKEN
SDK请求示例(JAVA)

DingTalkClient  client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/list_by_userid");
OapiMicroappListByUseridRequest req = new OapiMicroappListByUseridRequest();
req.setUserid("01376814877479");
req.setHttpMethod("GET");
OapiMicroappListByUseridResponse response = client.execute(req,accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "appList": [
        {
            "appIcon": "http://static.dingtalk.com/media/szIzMg_200_200.png",
            "agentId": 111,
            "appDesc": "应用描述",
            "isSelf": true,
            "name": "应用名称",
            "homepageLink": "http://oa.dingtalk.com/?h5",
            "pcHomepageLink": "http://oa.dingtalk.com/?pc",
            "appStatus": 1,
            "ompLink": "http://oa.dingtalk.com/index"
        }
}
参数
说明
errcode
返回码
errmsg
对返回码的文本描述内容
appIcon
应用图标
agentId
应用实例化id
appDesc
应用描述
isSelf
表示是否是自建应用
name
应用名称
homepageLink
应用的移动端主页
pcHomepageLink
应用的pc端主页
appStatus
应用状态,
1表示启用
0表示停用
ompLink
应用的OA后台管理主页

获取应用的可见范围

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/microapp/visible_scopes?access_token=ACCESS_TOKEN
请求包结构体

{
    "agentId": 16691682,
}

参数说明

参数 参数类型 必须 说明
access_token String 调用接口凭证
agentId Long 需要查询的应用实例化agentId

SDK请求示例(JAVA)

DingTalkClient  client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/visible_scopes");
OapiMicroappVisibleScopesRequest req = new OapiMicroappVisibleScopesRequest();
req.setAgentId(173398001L);
OapiMicroappVisibleScopesResponse response = client.execute(req, accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "isHidden":false,
    "deptVisibleScopes": [1265,9634],
    "userVisibleScopes": ["manager6577","766578"]
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
isHidden 是否仅限管理员可见
deptVisibleScopes 应用的可见部门id列表,格式为JSON数组
userVisibleScopes 应用的可见用户id列表,格式为JSON数组

设置应用的可见范围

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/microapp/set_visible_scopes?access_token=ACCESS_TOKEN
请求包结构体

{
    "agentId": 16691682,
    "isHidden":false,
    "deptVisibleScopes":[1,2],
    "userVisibleScopes":["userId1","userId2"]
}

参数说明

参数 参数类型 必须 说明
access_token String 调用接口凭证
agentId Long 应用实例化id
isHidden Boolean 是否仅限管理员可见,true代表仅限管理员可见
deptVisibleScopes JSON数组 设置可见的部门id列表,格式为JSON数组
userVisibleScopes JSON数组 设置可见的员工id列表,格式为JSON数组

SDK请求示例(JAVA)

DingTalkClient  client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/set_visible_scopes");
OapiMicroappSetVisibleScopesRequest req = new OapiMicroappSetVisibleScopesRequest();
req.setAgentId(173398001L);
req.setDeptVisibleScopes(Arrays.asList(0L));
req.setUserVisibleScopes(Arrays.asList("01376814877479"));
OapiMicroappSetVisibleScopesResponse response = client.execute(req, accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok"
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!