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

目录

  • 获取指定的应用详情
  • 获取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企业应用是否被停用
    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" 
    		}
    	]
    }
    
    
    

    参数说明:

    参数类型说明
    errcodeInteger出错返回码,为0表示成功,非0表示调用失败
    errmsgString返回码提示语
    agentlistAgentItemArray当前凭证可访问的应用列表

    AgentItem 结构

    参数类型说明
    agentidInteger企业应用id
    nameString企业应用名称
    square_logo_urlString企业应用方形头像url
    上一篇
    概述
    下一篇
    设置应用