1.1、message

1.1.1、文本

字段	数据类型	是否必有	描述
contentType	string	是	填写text/plain（文本类型）
contentEncoding	string	是	编码 utf8（默认） base64
contentText	string	是	文本内容文字个数[1, 2000]
suggestion	array[object]	否	悬浮菜单（点击事件的集合，点击事件个数[1, 11]）

{ 
  "message":{
    "contentType": "text/plain",
    "contentEncoding": "utf8",
    "contentText": "回复Y确认订阅",
    "suggestion": [
      {
        "reply": {
          "displayText": "Y",
          "postback": {
            "data": "回执操作"
          }
        }
      }
    ]
  }
}

1.1.2、文件

字段		数据类型	是否必有	描述
contentType		string	是	填写application/vnd.gsma.rcs-ft-http（文件类型）
contentEncoding		string	是	编码 utf8（默认） base64
contentText		object	是	对象
	fileId	string	是	素材编号来源：5G消息素材上传模板中的素材必须审核通过才能上传
	fileType	int	条件	素材的文件类型，见素材的文件类型枚举需要：当素材编号使用变量时，为必填，否则该字段无效来源：5G消息模板编辑
suggestion		array[object]	否	悬浮菜单（点击事件的集合，点击事件个数[1, 11]）

{
  "message": {
    "contentType": "application/vnd.gsma.rcs-ft-http",
    "contentEncoding": "utf8",
    "contentText": {
      "fileId": "abc123456789"
    },
    "suggestion": [
      {
        "action": {
          "displayText": "普通电话",
          "postback": {
            "data": "回执操作"
          },
          "dialerAction": {
            "dialPhoneNumber": {
              "phoneNumber": "15766666666"
            }
          }
        }
      }
    ]
  }
}

1.1.3、单卡片

1.1.3.1、单卡片参数

字段		数据类型	是否必有	描述
contentType		string	是	填写application/vnd.gsma.botmessage.v1.0+json（卡片类型）
contentEncoding		string	是	编码 utf8（默认） base64
contentText		object	是	内容对象
	generalPurposeCard	object	是	单卡片对象
suggestion		array[object]	否	悬浮菜单（点击事件的集合，点击事件个数[1, 11]）

1.1.3.2、generalPurposeCard

字段		数据类型	是否必有	描述
layout		object	是	布局对象
	cardOrientation	string	否	卡片定位（单卡片才有） VERTICAL 垂直（默认） HORIZONTAL 水平
	imageAlignment	string	条件	图片对齐（单卡片才有） LEFT 左对齐 RIGHT 右对齐必需：cardOrientation = HORIZONTAL（水平）
	titleFontStyle	array[string]	否	标题--字体样式 italics斜体 bold 粗体 underline 下划线
	descriptionFontStyle	array[string]	否	描述--字体样式 italics斜体 bold 粗体 underline 下划线
content		object	是	卡片内容单卡片类型只有一个卡片
	title	string	是	卡片的标题文字个数[1, 200]
	description	string	是	卡片的描述文字个数[1, 2000]
	media	object	是	卡片的素材
	suggestions	array[object]	否	建议菜单（点击事件的集合，点击事件个数[1, 4]）

1.1.3.3、media

字段	数据类型	是否必有	描述
mediaId	string	是	素材编号来源：5G消息素材上传
mediaType	int	条件	素材的文件类型，见素材的文件类型枚举需要：当素材编号使用变量时，为必填，否则该字段无效来源：5G消息模板编辑
height	string	否	高度 SHORT_HEIGHT 高度较低 MEDIUM_HEIGHT 高度适中（默认） TALL_HEIGHT 高度较高

1.1.3.4、单卡片数据结构示例

{
    "message": {
        "contentType": "application/vnd.gsma.botmessage.v1.0+json",
        "contentEncoding": "utf8",
        "contentText": {
            "generalPurposeCard": {
                "layout": {
                    "cardOrientation": "VERTICAL",
                    "titleFontStyle": [
                        "bold"
                    ],
                    "descriptionFontStyle": [
                        "calibri"
                    ]
                },
                "content": {
                    "media": {
                        "mediaId": "abc123456789",
                        "height": "TALL_HEIGHT"
                    },
                    "title": "卡片标题",
                    "description": "卡片描述"
                }
            }
        }
    }
}

1.1.4、多卡片

1.1.4.1、多卡片参数

字段		数据类型	是否必有	描述
contentType		string	是	填写application/vnd.gsma.botmessage.v1.0+json（卡片类型）
contentEncoding		string	是	编码 utf8（默认） base64
contentText		object	是	内容
	generalPurposeCardCarousel	object	是	多卡片
suggestion		array[object]	否	悬浮菜单（点击事件的集合，点击事件个数[1, 11]）

1.1.4.2、generalPurposeCardCarousel

字段		数据类型	是否必有	描述
layout		string	是	布局对象
	cardWidth	string	否	卡片宽度（多卡片） SMALL_WIDTH 宽度小（默认） MEDIUM_WIDTH 宽度适中
	titleFontStyle	array[string]	否	标题--字体样式 italics斜体 bold 粗体 underline 下划线
	descriptionFontStyle	array[string]	否	标题--字体样式 italics斜体 bold 粗体 underline 下划线
content		array[object]	是	卡片的集合多卡片类型有多张卡片，卡片个数[1, 12]
	title	string	是	卡片的标题文字个数[1, 200]
	description	string	是	卡片的描述文字个数[1, 2000]
	media	object	是	卡片的素材
	suggestions	array[object]	否	建议菜单（点击事件的集合，点击事件个数[1, 4]）

1.1.4.3、media

字段	数据类型	是否必有	描述
mediaId	string	是	素材编号来源：5G消息素材上传
mediaType	int	条件	素材的文件类型，见素材的文件类型枚举需要：当素材编号使用变量时，为必填，否则该字段无效来源：5G消息模板编辑
height	string	否	高度 SHORT_HEIGHT 高度较低 MEDIUM_HEIGHT 高度适中（默认） TALL_HEIGHT 高度较高

1.1.4.4、多卡片数据结构示例

{
  "message": {
    "contentType": "application/vnd.gsma.botmessage.v1.0+json",
    "contentEncoding": "utf8",
    "contentText": {
      "generalPurposeCardCarousel": {
        "layout": {
          "cardWidth": "MEDIUM_WIDTH",
          "titleFontStyle": [
            "bold"
          ],
          "descriptionFontStyle": [
            "calibri"
          ]
        },
        "content": [
          {
            "media": {
              "mediaId": "abc123456789",
              "height": "TALL_HEIGHT"
            },
            "title": "卡片1标题",
            "description": "卡片1描述"
          },
          {
            "title": "卡片2标题",
            "description": "卡片2描述",
            "media": {
              "mediaId": "abc123456789",
              "height": "SHORT_HEIGHT"
            }
          }
        ]
      }
    }
  }
}

1.1.5、地理位置

字段	数据类型	是否必有	描述
contentType	string	是	填写text/plain（地理位置类型）
contentEncoding	string	是	编码 utf8（默认） base64
contentText	string	是	地理位置，见地理位置格式说明
suggestion	array[object]	否	悬浮菜单（点击事件的集合，点击事件个数[1, 11]）

{
  "message": {
    "contentType": "text/plain",
    "contentEncoding": "utf8",
    "contentText": "geo:39.915031,116.403978;crs=gcj02;u=10;rcs-l=Qingfeng%20Steamed%20Dumpling%20Shop%20%F0%9F%8D%9A"
  }
}

地理位置格式说明：

geo:纬度,经度;crs=gcj02;u=10;rcs-l=标签
以geo:开头，紧跟纬度、经度，以英文“,”进行分割。crs表明坐标系统。rcs- l表明在地图上面的标签。标签需要经过url编码，支持Unicode字符。详见示例地理位置模板（里的4.5、地理位置模板+视信回落）标签原本格式内容：Qingfeng Steamed Dumpling Shop ? 标签编码后的格式：Qingfeng%20Steamed%20Dumpling%20Shop%20%F0%9F%8D%9A
示例： "contentText": "geo:50.7311865,7.0914591;crs=gcj02;u=10;rcs-l=Qingfeng%20Steamed%20Dumpling%20Shop%20%F0%9F%8D%9A",

文档更新时间: 2023-06-13 09:04 作者：夏亮

1.1、message

1.1、message

1.1.1、文本

1.1.2、文件

1.1.3、 单卡片

1.1.3.1、单卡片参数

1.1.3.2、generalPurposeCard

1.1.3.3、media

1.1.3.4、单卡片数据结构示例

1.1.4、多卡片

1.1.4.1、多卡片参数

1.1.4.2、generalPurposeCardCarousel

1.1.4.3、media

1.1.4.4、多卡片数据结构示例

1.1.5、地理位置

1.1.3、单卡片