消息类型

单图片消息和富文本消息格式定义

单图片消息格式

  1. 将通过文件上传到U聊服务器获得的文件的fileid
  2. 将fileid填写到json中即可,消息内容为json格式如下:

    [{"fileid":"2c908474468f588d01468f6a263b0000”}]
    
    富文本消息格式分为两类:
  3. 单、多图文混排格式

{
    "cover" : "可选,如留空,按第一条消息cover显示,封面大图,imageid或url",
    "degist" : "可选,如留空,按第一条消息degist显示,封面图片摘要",
    "articleCount" : "图文消息数目,消息数目为1,则为单图文消息",
    "publishTime" : "发布时间,可选,如留空,服务器自动填写当前时间",
    "articles" : [
        {
            "title" : "图文消息标题",
            "degist" : "图文消息简介",
            "cover" : "图文消息图片,imageid或url",
            "url" : "原文连接"
        },
        {
            "title" : "图文消息标题",
            "degist" : "图文消息简介",
            "cover" : "图文消息图片,imageid或url",
            "url" : "原文连接"
        }
    ]
}

单图文消息展现示例:

image

多图文消息展现示例:

image

  • 账单富文本消息格式
{
    "title" : "账单消息标题",
    "degist" : "账单消息摘要",
    "url" : "账单消息原文链接。如填空,消息下方无<详细>按钮,适合无需跳转场景",
    "publishTime" : "发布时间,可选,如留空,服务器自动填写当前时间",
    "styles" :  {
        "topColor" : "消息头标题栏颜色 如#ffc17d]",
        "style" : [
            {
                "range" : "样式适用范围,如{22,1}",
                "font" : "字体大小,s小号;m中号;xl大号",
                "color" : "文字颜色 如#ffc17d]",
            },
            {
                "range" : "样式适用范围, 如{30,5}",
                "font" : "字体大小,s小号;m中号;xl大号",
                "color" : "文字颜色 如#ffc17d]",
            }
        ]
    }
}

账单消息示例图如下:

image

公众号消息附加交换数据payload格式

根据不同的payload_type, payload格式如下:

零钱转账交易状态payload_type=00
{
    "tn":"1426841235979"
}

文件附件格式消息报文体content格式

文件附件报文体为json格式,各字段如下

  • fileid 调用upload接口将文件上传后获取文件id
  • filetype 文件类型,同文件上传调用upload接口时的类型取值
  • filename 文件名称,如“会议纪要.doc”
  • filesize 文件大小字节数

格式示例:

{
    "fileid": "25455-2124-1121212",
    "filetype": "excel",
    "filename": "交易简报0227.xls",
    "filesize": 65535421,
    "key": "xxxxxxxxxx"
}

互动型消息报文体content格式

说明:

  1. 支持互动型消息,用户可直接在消息气泡上进行操作。
  2. 对互动型消息,支持使用变更类回执修改气泡样式,包括但不限于新增字段、修改背景、修改某字段等。

互动型消息报文体为json格式,各字段如下

格式示例:

{
    "url" : "消息原文链接,供整体跳转。界面无需出现<详细>跳转按钮",
    "covertype" : "可选,1:imageid;2:url",
    "cover" : "可选,imageid或url。如留空表示无图片",
    "title" : {
      "content" : "消息标题", //正文
      "color" : "#ffc17d", //可选。颜色
      "font" : "m"        //可选。字体,s-小,m-中,l-大    
    },
    "body" : {
      "content" : "消息标题", //正文
      "color" : "#ffc17d", //可选。颜色
      "font" : "m"        //可选。字体,s-小,m-中,l-大   
    }
    "status" :
    {
        //1--该区域放action,对应btns字段,此时text无效 
        //2--放文字,对应text字段,此时btns无效
        "type" : "1", 
        "text" : {
            "content" : "消息标题", //正文
            "color" : "#ffc17d", //可选。颜色
            "font" : "m"        //可选。字体,s-小,m-中,l-大    
        }
        "btns": [
        {
              "name": "一个按钮",
            //click-点击事件,此时url为key; 
            //view-跳转,跳转至url;
            //open-本地调用,此时url为本地调用串
              "type": "view", 
              "url": "https://www.taobao.com", // 参见type取值说明
              "color": "#ffc17d", //可选。颜色
              "font" : "m"        //可选。字体,s-小,m-中,l-大    
            },
           {
              "name": "两个按钮",
              "type": "view",
              "url": "https://www.taobao.com",
              "color": "#ffc17d", //可选。颜色
              "font" : "m"        //可选。字体,s-小,m-中,l-大   
            }
        ]    
         } 
    "styles" :  {
        "statusBtnsVertical": "1", // 0-横排 1-竖排
        "bgColor" : "消息气泡底色 如#ffc17d]",
    }
}

互动型消息展现示例:

image

互动型消息回执报文体content格式

回执报文体为json格式,各字段如下

格式示例:

{
    "referedMsgId": "1234567890",//指定针对哪一条消息(该消息的msgID)进行回执
    "status":{
        "type" : "2",//1--该区域放action 2--放文字    
        "text" : {
          "content" : "中间状态或终极状态", //正文
          "color" : "#ffc17d", //可选。颜色
          "font" : "m"        //可选。字体,s-小,m-中,l-大    
        }
      },
    "styles" :  {
        "bgColor" : "消息气泡底色 如#ffc17d",
         "statusBtnsVertical": "1", // 0-横排 1-竖排
    }
}

results matching ""

    No results matching ""