Skip to content

同步应用角标

   应用角标同步到协作,让信息及时通知到用户。

功能介绍

   应用角标是应用的一种信息通知能力,类似于“即时消息”的未读消息数量标识。通过这一功能,应用图标的右上角会显示红色数字角标,提醒用户应用内有需要关注的信息或待处理的任务。除此之外,聚合可见应用的角标,显示在工作台图标的右上角,提醒用户需要关注的信息或待处理的总量。 角标支持展示的数字范围是 1 到 99,说明如下:

  • 当应用角标的待办数量小于等于 99 时,显示为红色数字。
  • 当应用角标的待办数量大于 99 时,显示为红点。
  • 当应用角标的待办数量为0时,不展示应用角标。
  • 示意图如下:
角标为00<角标<=99角标>99
image.pngimage.pngimage.png

请求

请求地址配置域名+/o/woa + /open/v7/app_badges/batch_set
请求方法POST
签名方式wps-4
支持应用类型企业自建应用
权限要求查询和管理应用角标(kso.app_badge.readwrite)

请求头

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorizationaccess_token(企业授权获取的token)

请求体

名称参数类型是否必填说明
badgesarray角标集合(容量20)
objectbadges数组单个元素
∟ ∟ user_idstringwps_uid
∟ ∟ sequenceinteger标识角标新旧,可用时间戳
∟ ∟ notification_countinteger角标值

响应体

名称类型说明
codeinteger响应码
msgstring提示信息

请求参数示例

json
{
  "badges": [
    {
      "user_id": "121212121",
      "sequence": 166436059,
      "notification_count": 20
    },
    {
      "user_id": "121212122",
      "sequence": 166436059,
      "notification_count": 2
    }
  ]
}

响应体示例

json
{
  "code": 0,
  "msg": "success"
}