WorkPlus 开放平台

主题

富文本消息 ​

注意

  • 富文本可以在一条消息中同时支持文字、At、图片、超链接等元素；
  • 一个富文本可分多个段落（由多个[]组成），每个段落可由多个元素组成，每个元素由tag和相应的字段描述组成；
  • 图片元素必须是独立的一个段落。

消息示例 ​

点击查看示例
JSON
{
  "title": "这是富文本的标题",
  "content": [
    [
      {
        "tag": "text",
        "style": {
          "lineThrough": true,
          "bold": true,
          "italic": true,
          "color": "default"
        },
        "text": "这是第一段文字\n"
      },
      {
        "user_id": "1fee2dd7a3ba457db5beb78b12ba10cf",
        "name": "张三",
        "tag": "at"
      },
      {
        "tag": "text",
        "text": " ",
        "style": {
          "lineThrough": false,
          "bold": false,
          "italic": false,
          "color": "default"
        }
      },
      {
        "user_id": "all",
        "name": "全部人员",
        "tag": "at"
      },
      {
        "style": {
          "lineThrough": false,
          "bold": false,
          "italic": false,
          "color": "default"
        },
        "text": " \n",
        "tag": "text"
      },
      {
        "text": "百度一下",
        "tag": "a",
        "href": "https://www.baidu.com"
      },
      {
        "style": {
          "lineThrough": false,
          "bold": false,
          "italic": false,
          "color": "blue"
        },
        "text": "这是第二段文字蓝色的\n",
        "tag": "text"
      },
      {
        "style": {
          "lineThrough": false,
          "bold": false,
          "italic": false,
          "color": "red"
        },
        "tag": "text",
        "text": "这是第三段文字红色的\n"
      },
      {
        "style": {
          "lineThrough": false,
          "bold": false,
          "italic": false,
          "color": "grey"
        },
        "text": "这是第四段文字灰色的",
        "tag": "text"
      }
    ],
    [
      {
        "thumbnail_id": "c42b6543bc164f709bbbb066640bcf9b",
        "original_media_id": "3505e93f2831473ab9daf4c95e9fc951",
        "is_gif": false,
        "height": 1920,
        "width": 888,
        "size": 223563,
        "tag": "img",
        "media_id": "d42040947d644a1fbcecd2c3edd08bc6"
      }
    ]
  ]
}

参数说明 ​

参数名字段类型必须说明
titlestring否标题
contentarray是富文本消息内容，由多个段落组成，每个段落为一个 node 列表。
支持的 node 标签类型及对应参数，参见下文：支持的标签和参数说明。

支持的标签和参数说明 ​

  • style（字体样式）：
参数名字段类型必须说明
lineThroughbool否删除线
boldbool否粗体
italicbool否斜体
colorstring否default: 默认值，会根据暗黑模式自动切换
red: 红色
blue: 蓝色
grey: 灰色
  • text(文本)：
参数名字段类型必须说明
textstring是文本内容
stylestyle否字体样式，字段见上
  • at(@人)：
参数名字段类型必须说明
user_idstring是用户的 user_id 或者 all
namestring是用户名字或者全部人员
  • a(超链接)：
参数名字段类型必须说明
textstring是显示的文字
hrefstring是链接的地址，例如: https://workplus.io, 也可以是一些 App 内部的路由地址
  • img(图片)：
参数名字段类型必须说明
thumbnail_idstring否缩略图id
media_idstring是标准图id
original_media_idstring否原图id
is_gifbool否是否是gif
widthint是宽
heightint是高
sizeint否(如果原图有值，则必须)原图大小，大小为字节

请求体示例 ​

JSON
{
  "type": "RICH_TEXT", 
  "body": {
    "content": "{\"title\":\"这是富文本的标题\",\"content\":[[{\"tag\":\"text\",\"style\":{\"lineThrough\":true,\"bold\":true,\"italic\":true,\"color\":\"default\"},\"text\":\"这是第一段文字\\n\"},{\"user_id\":\"1fee2dd7a3ba457db5beb78b12ba10cf\",\"name\":\"张三\",\"tag\":\"at\"},{\"tag\":\"text\",\"text\":\" \",\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"default\"}},{\"user_id\":\"all\",\"name\":\"全部人员\",\"tag\":\"at\"},{\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"default\"},\"text\":\" \\n\",\"tag\":\"text\"},{\"text\":\"百度一下\",\"tag\":\"a\",\"href\":\"https://www.baidu.com\"},{\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"default\"},\"text\":\" \\n\",\"tag\":\"text\"},{\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"blue\"},\"text\":\"这是第二段文字蓝色的\\n\",\"tag\":\"text\"},{\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"red\"},\"tag\":\"text\",\"text\":\"这是第三段文字红色的\\n\"},{\"style\":{\"lineThrough\":false,\"bold\":false,\"italic\":false,\"color\":\"grey\"},\"text\":\"这是第四段文字灰色的\",\"tag\":\"text\"}],[{\"thumbnail_id\":\"c42b6543bc164f709bbbb066640bcf9b\",\"original_media_id\":\"3505e93f2831473ab9daf4c95e9fc951\",\"is_gif\":false,\"height\":1920,\"width\":888,\"size\":223563,\"tag\":\"img\",\"media_id\":\"d42040947d644a1fbcecd2c3edd08bc6\"}]]}"
  }, 
  "usernames": [
    "13800138000"
  ],
  "platforms": [
    "ANDROID","IOS","PC"
  ]
}

消息发送后的效果如下图：

app-rich-text.png