# 互动消息卡片基础元素
# i18n 国际化对象
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
zh_cn | String | 是 | 中文文案 | 支持 | 支持 | 支持 |
en_us | String | 是 | 英文文案 | 支持 | 支持 | 支持 |
JSON 示例:
{
"zh_cn": "这是一个中文的文本",
"en_us": "This is a text"
}
# AttributedString 富文本对象
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
id | String | 是 | 组件id | 支持 | 支持 | 支持 |
text_color | String | 否 | 文本颜色 | 支持 | 支持 | 支持 |
text_size | Int | 否 | 字体大小 | 支持 | 支持 | 支持 |
text_weight | String | 否 | 文字粗细 | 支持 | 不支持 | 不支持 |
icon_url | String | 否 | 图片 url,icon_url 有值则展示 icon,无值则展示 content | 支持 | 支持 | 支持 |
icon_width | Int | 否 | 图片宽度,默认20px | 支持 | 支持 | 支持 |
icon_height | Int | 否 | 图片高度,默认20px | 支持 | 支持 | 支持 |
icon_jump_url | String | 否 | icon_jump_url 如果存在,点击 icon 跳转对应地址;不存在,点击 icon 展示 content 内容 | 支持 | 支持 | 支持 |
content | String | 否 | 没有 icon 时为展示的文本; 有 icon 时, 为 icon 的 tips | 支持 | 支持 | 支持 |
JSON 示例:
{
"id": "id1",
"text_color": "FFFFFF",
"text_size": 16,
"text_weight": 500,
"icon_url": "http://sssssss",
"icon_width": 20,
"icon_height": 20,
"icon_jump_url": "http://sssssss",
"content": "文案"
}
# 文本元素
普通文本 i18n
JSON 示例:
{
"type": "plain_text",
"i18n": {
"zh_cn": "这是一个中文文本",
"en_us": "This is a English text"
}
}
Markdown
JSON 示例:
{
"type": "markdown",
"i18n": {
"zh_cn": "这是一个中文的 Markdown",
"en_us": "This is a markdown"
}
}
富文本 attributes_i18n
JSON 示例,具体字段含义参考AttributedString 富文本对象:
{
"type": "plain_text",
"attributes_i18n": {
"zh_cn": [{
"id": "id1",
"text_color": "FFFFFF",
"text_size": 16,
"text_weight": 500,
"icon_url": "http://sssssss",
"icon_width": 20,
"icon_height": 20,
"icon_jump_url": "http://sssssss",
"content": "文案"
}],
"en_us": [{
"id": "id1",
"text_color": "FFFFFF",
"text_size": 16,
"text_weight": 500,
"icon_url": "http://sssssss",
"icon_width": 20,
"icon_height": 20,
"icon_jump_url": "http://sssssss",
"content": "文案"
}]
}
}
# Option 选项
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
id | String | 是 | 组件id | 支持 | 支持 | 支持 |
text | Struct | 是 | 选项文案,参考i18n | 支持 | 支持 | 支持 |
JSON 示例:
{
"id": "1111",
"text": {
"i18n": {
"zh_cn": "这是一个中文的 Markdown",
"en_us": "This is a markdown"
}
}
}
# Confirm 确认弹窗
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
title | Struct | 是 | 弹窗标题,参考i18n | 支持 | 支持 | 支持 |
content | Struct | 是 | 弹窗内容,参考i18n | 支持 | 支持 | 支持 |
JSON 示例:
{
"title": {
"i18n": {
"zh_cn": "确认",
"en_us": "ssss"
}
},
"content": {
"i18n": {
"zh_cn": "tip",
"en_us": "ssss"
}
}
}
# Button 按钮
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
id | String | 是 | 组件id | 支持 | 支持 | 支持 |
disable | Int | 否 | 是否封禁,默认为0,1:为可点击;0:可点击; | 支持 | 支持 | 支持 |
text | Struct | 是 | 按钮文本,参考i18n | 支持 | 支持 | 支持 |
click_success | Struct | 否 | 参考 click_success 参数说明 | 支持 | 支持 | 支持 |
extra | String | 否 | 扩展字段,客户端请求接口透传 | 支持 | 支持 | 支持 |
text_color | String | 否 | 按钮文字颜色,默认为:"286cfb" | 支持 | 支持 | 支持 |
border_color | String | 否 | 按钮边框颜色,默认为:"286cfb" | 支持 | 支持 | 支持 |
background_color | String | 否 | 按钮背景颜色,默认为:"ffffff" | 支持 | 支持 | 支持 |
url | String | 是 | 点击跳转的url或者接口请求地址 | 支持 | 支持 | 支持 |
pc_url | String | 是 | pc点击跳转的url或者接口请求地址,如果没有就使用url的值 | 支持 | 支持 | 支持 |
android_url | String | 是 | android点击跳转的url或者接口请求地址 ,如果没有就使用url的值 | 支持 | 支持 | 支持 |
ios_url | String | 是 | ios点击跳转的url或者接口请求地址 ,如果没有就使用url的值 | 支持 | 支持 | 支持 |
action_type | String | 是 | 点击按钮的动作,request 为请求接口,forward 为链接跳转 | 支持 | 支持 | 支持 |
icon_url | String | 否 | 按钮图片 url | 支持 | 支持 | 支持 |
icon_position | Int | 否 | 图片位置,0:左边,1右边 | 支持 | 支持 | 支持 |
repeat_commit | Int | 否 | 是否允许重复提交,0:不允许,1:允许 | 支持 | 支持 | 支持 |
retrieve_values | String[] | 否 | 数组元素为组件 id,点击按钮请求接口,需要传回对应组件填充内容 | 支持 | 支持 | 支持 |
confirm | Confirm | 否 | 点击按钮的确认弹窗,参考Confirm 确认弹窗 | 支持 | 支持 | 支持 |
# click_success 参数说明
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
i18n | i18n | 是 | 点击按钮接口请求成功之后按钮的样式 | 支持 | 支持 | 支持 |
text_color | String | 是 | 文字颜色 | 支持 | 支持 | 支持 |
border_color | String | 是 | 按钮边框颜色 | 支持 | 支持 | 支持 |
background_color | String | 是 | 按钮背景颜色 | 支持 | 支持 | 支持 |
JSON 示例:
{
"id": "123",
"disable": 0,
"text": {
"i18n": {
"zh_cn": "接受",
"en_us": "accept"
}
},
"click_success": {
"i18n": {
"zh_cn": "接受",
"en_us": "accept"
},
"text_color": "FFFFFF",
"border_color": "DDEEFF",
"background_color": "223344"
},
"extra": "",
"text_color": "FFFFFF",
"border_color": "DDEEFF",
"background_color": "223344",
"url": "跳转或者请求地址",
"android_url": "android地址,如果没有的话使用url的值",
"pc_url": "pc地址,如果没有的话使用url的值",
"ios_url": "ios地址,如果没有的话使用url的值",
"icon_url": "http://aaa",
"icon_position": 0,
"action_type": "request",
"repeat_commit": 1,
"retrieve_values": [
"123",
"456"
],
"confirm": {
"title": {
"i18n": {
"zh_cn": "确认",
"en_us": "ssss"
}
},
"content": {
"i18n": {
"zh_cn": "tip",
"en_us": "ssss"
}
}
}
}
# UserInfo 人员信息
# 参数
参数 | 参数类型 | 必须 | 说明 | PC | iOS | Android |
---|---|---|---|---|---|---|
id | String | 是 | 用户id | 支持 | 支持 | 支持 |
depart_name | Struct | 是 | 参考i18n | 支持 | 支持 | 支持 |
pic | String | 是 | 用户头像url | 支持 | 支持 | 支持 |
name | Struct | 是 | 参考i18n | 支持 | 支持 | 支持 |
is_locked | Bool | 是 | 存在且为 true,则不允许操作 | 支持 | 支持 | 支持 |
{
"id": 11223,
"depart_name": {
"i18n": {
"zh_cn": "部门",
"en_us": "bumen"
}
},
"pic": "http://xxxxx",
"name": {
"i18n": {
"zh_cn": "鲍国妹",
"en_us": "bgm"
}
},
"is_locked": false
}