获取应用 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 应用管理获取应用

调试工具

获取应用

最后更新：2023/10/31

获取指定的应用详情

获取access_token对应的应用列表

获取指定的应用详情

请求方式：GET（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/agent/get?access_token=ACCESS_TOKEN&agentid=AGENTID
参数说明：

参数	必须	说明
access_token	是	调用接口凭证
agentid	是	应用id

权限说明：
企业仅可获取当前凭证对应的应用；第三方仅可获取被授权的应用。

返回结果：

{
   "errcode": 0,
   "errmsg": "ok",
   "agentid": 1000005,
   "name": "HR助手",
   "square_logo_url":  "https://p.qlogo.cn/bizmail/FicwmI50icF8GH9ib7rUAYR5kicLTgP265naVFQKnleqSlRhiaBx7QA9u7Q/0",
   "description": "HR服务与员工自助平台",
   "allow_userinfos": {
       "user": [
             {"userid": "zhangshan"},
             {"userid": "lisi"}
       ]
    },
   "allow_partys": {
       "partyid": [1]
    },
   "allow_tags": {
       "tagid": [1,2,3]
    },
   "close": 0,
   "redirect_domain": "open.work.weixin.qq.com",
   "report_location_flag": 0,
   "isreportenter": 0,
   "home_url": "https://open.work.weixin.qq.com",
   "customized_publish_status":1
}

参数说明：

参数	说明
errcode	出错返回码，为0表示成功，非0表示调用失败
errmsg	返回码提示语
agentid	企业应用id
name	企业应用名称
square_logo_url	企业应用方形头像
description	企业应用详情
allow_userinfos	企业应用可见范围（人员），其中包括userid
allow_partys	企业应用可见范围（部门）
allow_tags	企业应用可见范围（标签）
close	企业应用是否被停用。0：未被停用；1：被停用
redirect_domain	企业应用可信域名
report_location_flag	企业应用是否打开地理位置上报 0：不上报；1：进入会话上报；
isreportenter	是否上报用户进入应用事件。0：不接收；1：接收
home_url	应用主页url
customized_publish_status	代开发自建应用返回该字段，表示代开发发布状态。0：待开发（企业已授权，服务商未创建应用）；1：开发中（服务商已创建应用，未上线）；2：已上线（服务商已上线应用且不存在未上线版本）；3：存在未上线版本（服务商已上线应用但存在未上线版本）

获取access_token对应的应用列表

请求方式：GET（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/agent/list?access_token=ACCESS_TOKEN

参数说明：

参数	必须	说明
access_token	是	调用接口凭证

权限说明：
企业仅可获取当前凭证对应的应用；第三方仅可获取被授权的应用。

返回结果：

{
	"errcode":0,
	"errmsg":"ok" ,
	"agentlist":[
		{
			"agentid": 1000005,
			"name": "HR助手",
			"square_logo_url": "https://p.qlogo.cn/bizmail/FicwmI50icF8GH9ib7rUAYR5kicLTgP265naVFQKnleqSlRhiaBx7QA9u7Q/0" 
		}
	]
}

参数说明：

参数	类型	说明
errcode	Integer	出错返回码，为0表示成功，非0表示调用失败
errmsg	String	返回码提示语
agentlist	AgentItemArray	当前凭证可访问的应用列表

AgentItem 结构：

参数	类型	说明
agentid	Integer	企业应用id
name	String	企业应用名称
square_logo_url	String	企业应用方形头像url

概述

设置应用

本节内容

获取指定的应用详情
获取access_token对应的应用列表