微应用接口

class dingtalk.client.api.MicroApp(client=None)

create(app_icon, app_name, app_desc, homepage_url, pc_homepage_url=None, omp_link=None)

创建微应用

参数:

• app_icon – 微应用的图标。需要调用上传接口将图标上传到钉钉服务器后获取到的mediaId
• app_name – 微应用的名称。长度限制为1~10个字符
• app_desc – 微应用的描述。长度限制为1~20个字符
• homepage_url – 微应用的移动端主页，必须以http开头或https开头
• pc_homepage_url – 微应用的PC端主页，必须以http开头或https开头，如果不为空则必须与homepageUrl的域名一致
• omp_link – 微应用的OA后台管理主页，必须以http开头或https开头。

返回:

微应用实例化id

delete(agent_id)

删除微应用

参数:agent_id – 微应用实例化id，企业只能删除自建微应用 返回:

list()

列出微应用

返回:微应用列表

list_by_userid(userid)

列出员工可见的微应用

返回:微应用列表

set_visible_scopes(agent_id, is_hidden=False, dept_visible_scopes=(), user_visible_scopes=())

设置微应用的可见范围

参数:

• agent_id – 微应用实例化id
• is_hidden – 是否仅限管理员可见，true代表仅限管理员可见
• dept_visible_scopes – 设置可见的部门id列表
• user_visible_scopes – 设置可见的员工id列表

返回:

update(agent_id, app_icon=None, app_name=None, app_desc=None, homepage_url=None, pc_homepage_url=None, omp_link=None)

更新微应用

参数:

• agent_id – 微应用实例化id
• app_icon – 微应用的图标。需要调用上传接口将图标上传到钉钉服务器后获取到的mediaId
• app_name – 微应用的名称。长度限制为1~10个字符
• app_desc – 微应用的描述。长度限制为1~20个字符
• homepage_url – 微应用的移动端主页，必须以http开头或https开头
• pc_homepage_url – 微应用的PC端主页，必须以http开头或https开头，如果不为空则必须与homepageUrl的域名一致
• omp_link – 微应用的OA后台管理主页，必须以http开头或https开头。

返回:

微应用实例化id

visible_scopes(agent_id)

删除微应用

参数:agent_id – 需要查询的微应用实例化agentId 返回: