说明 - 企业微信 API

在企业微信管理端启用工作台自定义展示，可以通过接口配置应用在企业微信移动端工作台的展示类型。具体可设置关键数据型、图片型、列表型以及webview型。如下图所示：

首先需要通过“设置应用在工作台展示的模版”接口设置应用自定义模版类型。然后再通过“设置应用在用户工作台展示的数据”接口设置用户模版数据。
“设置应用在工作台展示的模版”同时也支持设置一个默认的企业级别的模版数据。在用户数据未设置的情况下，会展示企业级别的默认数据。
若为第三方应用，目前仅支持行业类型为 学前教育、初中等教育、教育行政单位 的企业可看到自定义工作台设置入口

模版类型数据结构

关键数据型

{
    "items":[
        {
            "key":"待审批",
            "data":"2",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        },
        {
            "key":"带批阅作业",
            "data":"4",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        },
        {
            "key":"成绩录入",
            "data":"45",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        },
        {
            "key":"综合评价",
            "data":"98",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        }
    ]
}

参数说明：

参数	必须	说明
items	是	关键数据列表个，不超过4个
items.key	否	关键数据名称，需要设置在模版中
items.data	是	关键数据
items.jump_url	否	点击跳转url，若不填且应用设置了主页url，则跳转到主页url，否则跳到应用会话窗口
items.pagepath	否	若应用为小程序类型，该字段填小程序pagepath，若未设置，跳到小程序主页

type为 “keydata”

在工作台展示效果如下：

图片型

{    "url":"xxxx",    "jump_url":"http://www.qq.com",    "pagepath":"pages/index"}

参数说明：

参数	必须	说明
url	否	图片url。图片的最佳比例为3.35:1
jump_url	否	点击跳转url。若不填且应用设置了主页url，则跳转到主页url，否则跳到应用会话窗口
pagepath	否	若应用为小程序类型，该字段填小程序pagepath，若未设置，跳到小程序主页

type为 “image”

在工作台展示效果如下：

列表型

{
    "items":[
        {
            "title":"智慧校园新版设计的小程序要来啦",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        },
        {
            "title":"植物百科，这是什么花",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        },
        {
            "title":"周一升旗通知，全体学生必须穿校服",
            "jump_url":"http://www.qq.com",
            "pagepath":"pages/index"
        }
    ]
}

参数说明：

参数	必须	说明
items	是	关键数据列表个，不超过3个
items.title	是	列表显示文字，不超过128个字节
items.jump_url	否	点击跳转url，若不填且应用设置了主页url，则跳转到主页url，否则跳到应用会话窗口
items.pagepath	否	若应用为小程序类型，该字段填小程序pagepath，若未设置，跳到小程序主页

type为 “list”

在工作台展示效果如下：

webview型

{    "url":"http://www.qq.com",    "jump_url":"http://www.qq.com",    "pagepath":"pages/index"}

参数说明：

参数	必须	说明
url	否	渲染展示的url
jump_url	否	点击跳转url。若不填且应用设置了主页url，则跳转到主页url，否则跳到应用会话窗口
pagepath	否	若应用为小程序类型，该字段填小程序pagepath，若未设置，跳到小程序主页

type为 “webview”
webview在工作台的高度固定为170px

在工作台展示效果如下：

https://open.work.weixin.qq.com/api/doc/90000/90135/90227#24275)

说明

模版类型数据结构#

关键数据型#

图片型#

列表型#

webview型#

模版类型数据结构

关键数据型

图片型

列表型

webview型