# sendMessageCard
发送消息卡片到指定会话。
注意事项：
- 网页应用调用前，需前置成功调用requestAuthCode
- 卡片的多端差异化配置，版本<3.20.0不支持，建议只配置兜底url，版本>=3.20.0支持多端差异化配置
# 支持说明
| 应用能力 | Android | iOS | PC | 预览效果 |
|---|---|---|---|---|
| 小程序 | 3.11.0 | 3.11.0 | 3.11.0 | 扫码预览 用BoosHi扫码或PC端点击 |
| 网页应用 | 3.11.0 | 3.11.0 | 3.11.0 | 待补充 |
# 输入
继承标准对象输入，扩展属性描述：
注意事项：
- 当前实现版本，ios、安卓仅支持手动选择联系人发送，指定openChatId的方式后续支持
- bosshi内有多种消息卡片，消息体尚未统一，当前暂时使用枚举值的方式支持，预计明年Q1服务端会统一消息体
| 名称 | 数据类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| shouldChooseChat | boolean | 否 | false | 是否在选择会话页面中发送卡片，如果该字段设置为true, 会跳转到选择会话页面并进行后续操作来完成卡片的发送。 openIDs 和 openChatIDs指定的用户跟群聊会自动勾选 |
| chooseChatParams | object | 否 | 若 shouldChooseChat 输入为true，则可以定制选择会话的入参，参考选择会话chooseChat。待开发 | |
| openChatIDs | string[] | 否 | 开放平台 openChatId (群聊)列表。 示例值：["chatID1","chatID2"] | |
| openIDs | string[] | 否 | 开放平台 openid (单聊)列表。不支持指定机器人示例值：["chatID1","chatID2"] | |
| triggerCode | string | 否 | 群聊打开场景通过triggerCode获取的值，可以通过该参数直接发送到对应群聊。 仅在会话应用打开场景有效。三端3.6支持 | |
| cardContent | object | 否 | 消息卡片内容。 | |
| ∟ msg_type | string | 否 | 消息的类型（预留字段暂时可以不传） | |
| ∟ card | object | 否 | 消息卡片的描述内容，参考卡片结构：消息卡片参考 | |
| withAdditionalMessage | boolean | 否 | false | 若 withAdditionalMessage 输入为true，则在发送卡片时开启发送附带留言的能力。 示例值：true |
# 输出
success返回对象的扩展属性：
| 名称 | 数据类型 | 描述 |
|---|---|---|
| errMsg | string | 错误消息。 |
| sendCardInfo | string[] | 发送消息卡片的message信息（只有消息发送动作产生时才会返回该字段; 例如没有传 openChatIDs，用户取消发送，解析卡片内容失败等情况都不会返回该字段）。 |
| ∟ status | number | 发送消息的状态码，0表示发送成功，1表示发送失败 |
| ∟ id | string | 单聊：开放平台openid机器人：加密的bosshi userid（开放平台目前没有属于机器人的openid）示例：ou_aea5df288c71a47af6ccd786c05be939 |
| ∟ chatType | number | 会话类型 可选值： 0：单聊1：群聊 |
| ∟ userType | number | 单聊类型 可选值： 0：普通用户1：机器人(仅在chatType为0时返回此参数) |
| ∟ openMessageId | string | open_message_id暂不支持 |
# 示例代码
bz.sendMessageCard({
shouldChooseChat: true,
chooseChatParams: {
"allowCreateGroup": true,
"multiSelect": true,
"externalChat": false,
"confirmTitle": "testTitle"
},
triggerCode: '',
openChatIDs: [],
openIDs: [],
cardType: 1,
cardContent: {
msg_type: '',
card: {
"header": {
"text": {
"content": "多文本1",
"tag": "plain_text"
},
"color": "grey"
},
"cardLink": {
"url": "https://www.baidu.com",
"pcUrl": "https://applink-bosshi.zhipin.com/client/applet/open?appId=bli_oevewdg1jm4ngjvv",
"androidUrl": "",
"iosUrl": "https://applink-bosshi.zhipin.com/client/applet/open?appId=bli_oevewdg1jm4ngjvv"
},
"globalConfig": {
"forward": true,
"shareCard": true
},
"modules": [
{
"title": {
"tag": "plain_text",
"content": "图片模块"
},
"image": {
"imgKey": "ade4bab797daa516jwFaTrfq3LOHdOfnIXEwYrmQzxtXN0CX5Azo6wTXz_Ws-sHsSAy7d5Css-Q1WMZjHlYqmxj8XyDw9vC1BpSzi4CuAcemLJnxTFuJDOZbYbd_umWklAQWUCjV0vRbmtfMVaSTbeSY_sl9Ws1HGg48RowjcYOmGmVk6eBXUHDe",
"alt": {
"tag": "plain_text",
"content": "图片文本"
},
"preview": true
},
"tag": "img"
},
{
"tag": "split_line"
},
{
"text": {
"tag": "plain_text",
"content": "内容模块文本1"
},
"tag": "div"
},
{
"content": {
"tag": "hi_md",
"content": "**加粗** *斜体* ***加粗斜体*** ~~删除线~~ **~~加粗删除线~~** ***~~加粗斜体删除线~~*** [测试链接](www.baidu.com)"
},
"textAlign": "left",
"multiUrl": {
"url": "https://www.baidu.com",
"pcUrl": "https://www.4399.com",
"androidUrl": "",
"iosUrl": "https://www.4399.com"
},
"tag": "markdown"
},
{
"text": {
"tag": "hi_md",
"content": "**加粗** *斜体* ***加粗斜体*** ~~删除线~~ **~~加粗删除线~~** ***~~加粗斜体删除线~~*** [测试链接](www.baidu.com)"
},
"tag": "div"
},
{
"text": {
"tag": "plain_text",
"content": "内容模块文本2"
},
"fields": [
{
"text": {
"tag": "plain_text",
"content": "多文本1"
},
"needLayout": true
},
{
"text": {
"tag": "plain_text",
"content": "多文本2"
},
"needLayout": true
},
{
"text": {
"tag": "plain_text",
"content": "多文本3"
},
"needLayout": true
},
{
"text": {
"tag": "plain_text",
"content": "多文本4"
},
"needLayout": true
}
],
"extra": {
"tag": "img",
"imgKey": "ade4bab797daa516jwFaTrfq3LOHdOfnIXEwYrmQzxtXN0CX5Azo6wTXz_Ws-sHsSAy7d5Css-Q1WMZjHlYqmxj8XyDw9vC1BpSzi4CuAcemLJnxTFuJDOZbYbd_umWklAQWUCjV0vRbmtfMVaSTbeSY_sl9Ws1HGg48RowjcYOmGmVk6eBXUHDe",
"alt": {
"tag": "plain_text",
"content": "提示hover"
},
"preview": true
},
"arrange": "bisected",
"tag": "div"
},
{
"actions": [
{
"text": {
"tag": "plain_text",
"content": "有回调的按钮"
},
"multiUrl": {
"url": "https://www.baidu.com",
"pcUrl": "https://www.4399.com",
"androidUrl": "",
"iosUrl": ""
},
"callBacks": [
{
"key": "click1",
"value": "1"
}
],
"confirm": {
"title": {
"tag": "plain_text",
"content": "弹窗标题"
},
"text": {
"tag": "plain_text",
"content": "弹窗内容"
}
},
"type": "primary",
"tag": "button",
"needLayout": true
},
{
"tag": "list_selector",
"placeholder": {
"tag": "plain_text",
"content": "默认文本"
},
"initialOption": "joy",
"options": [
{
"text": {
"tag": "plain_text",
"content": "下拉选项文本1"
},
"value": "joy"
},
{
"text": {
"tag": "plain_text",
"content": "下拉选项文本2"
},
"value": "2"
}
],
"callBacks": [
{
"key": "click1",
"value": "1"
}
],
"needLayout": true
}
],
"arrange": "bisected",
"tag": "actions"
},
{
"elements": [
{
"tag": "img",
"imgKey": "ade4bab797daa516jwFaTrfq3LOHdOfnIXEwYrmQzxtXN0CX5Azo6wTXz_Ws-sHsSAy7d5Css-Q1WMZjHlYqmxj8XyDw9vC1BpSzi4CuAcemLJnxTFuJDOZbYbd_umWklAQWUCjV0vRbmtfMVaSTbeSY_sl9Ws1HGg48RowjcYOmGmVk6eBXUHDe",
"preview": true,
"alt": {
"tag": "plain_text",
"content": "备注图片1"
}
},
{
"tag": "plain_text",
"content": "备注文本1"
},
{
"tag": "plain_text",
"content": "备注文本2"
}
],
"tag": "note"
}
]
}
},
withAdditionalMessage: true,
success(res) {
bz.showModal({
title: '成功',
content: JSON.stringify(res)
})
},
fail(res) {
bz.showModal({
title: '失败',
content: JSON.stringify(res)
})
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
success返回对象示例：
{
"sendCardInfo": [
{
"openMessageId": "",
"id": "",
"status": 0,
"chatType": 0,
"userType": 1
}
],
"errMsg": "sendMessageCard:ok"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12