@@ -47,9 +47,9 @@ public interface WxMpService {
47
47
* <pre>
48
48
* 获取access_token,本方法线程安全
49
49
* 且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限
50
- *
50
+ *
51
51
* 另:本service的所有方法都会在access_token过期是调用此方法
52
- *
52
+ *
53
53
* 程序员在非必要情况下尽量不要主动调用此方法
54
54
55
55
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
@@ -111,14 +111,143 @@ public interface WxMpService {
111
111
*/
112
112
public WxMediaUploadResult mediaUpload (String mediaType , String fileType , InputStream inputStream ) throws WxErrorException , IOException ;
113
113
114
+ /**
115
+ * <pre>
116
+ * 上传非图文永久素材
117
+ *
118
+ * 上传的多媒体文件有格式和大小限制,如下:
119
+ * 图片(image): 图片大小不超过2M,支持bmp/png/jpeg/jpg/gif格式
120
+ * 语音(voice):语音大小不超过5M,长度不超过60秒,支持mp3/wma/wav/amr格式
121
+ * 视频(video):在上传视频素材时需要POST另一个表单,id为description,包含素材的描述信息,内容格式为JSON
122
+ * 缩略图(thumb):文档未说明
123
+ *
124
+ * 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
125
+ * </pre>
126
+ * @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
127
+ * @param material 上传的素材, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterial}
128
+ * @return
129
+ * @throws WxErrorException
130
+ */
131
+ public WxMpMaterialUploadResult materialFileUpload (String mediaType , WxMpMaterial material ) throws WxErrorException ;
132
+
133
+ /**
134
+ * <pre>
135
+ * 上传永久图文素材
136
+ *
137
+ * 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
138
+ * </pre>
139
+ * @param news 上传的图文消息, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterialNews}
140
+ * @return
141
+ * @throws WxErrorException
142
+ */
143
+ public WxMpMaterialUploadResult materialNewsUpload (WxMpMaterialNews news ) throws WxErrorException ;
144
+
145
+ /**
146
+ * <pre>
147
+ * 下载声音或者图片永久素材
148
+ *
149
+ * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
150
+ * </pre>
151
+ * @param media_id 永久素材的id
152
+ * @return
153
+ * @throws WxErrorException
154
+ */
155
+ public InputStream materialImageOrVoiceDownload (String media_id ) throws WxErrorException ;
156
+
157
+ /**
158
+ * <pre>
159
+ * 获取视频永久素材的信息和下载地址
160
+ *
161
+ * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
162
+ * </pre>
163
+ * @param media_id 永久素材的id
164
+ * @return
165
+ * @throws WxErrorException
166
+ */
167
+ public WxMpMaterialVideoInfoResult materialVideoInfo (String media_id ) throws WxErrorException ;
168
+
169
+ /**
170
+ * <pre>
171
+ * 获取图文永久素材的信息
172
+ *
173
+ * 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
174
+ * </pre>
175
+ * @param media_id 永久素材的id
176
+ * @return
177
+ * @throws WxErrorException
178
+ */
179
+ public WxMpMaterialNews materialNewsInfo (String media_id ) throws WxErrorException ;
180
+
181
+ /**
182
+ * <pre>
183
+ * 更新图文永久素材
184
+ *
185
+ * 详情请见: http://mp.weixin.qq.com/wiki/4/19a59cba020d506e767360ca1be29450.html
186
+ * </pre>
187
+ * @param wxMpMaterialArticleUpdate 用来更新图文素材的bean, 请看{@link me.chanjar.weixin.mp.bean.WxMpMaterialArticleUpdate}
188
+ * @return
189
+ * @throws WxErrorException
190
+ */
191
+ public boolean materialNewsUpdate (WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate ) throws WxErrorException ;
192
+
193
+ /**
194
+ * <pre>
195
+ * 删除永久素材
196
+ *
197
+ * 详情请见: http://mp.weixin.qq.com/wiki/5/e66f61c303db51a6c0f90f46b15af5f5.html
198
+ * </pre>
199
+ * @param media_id 永久素材的id
200
+ * @return
201
+ * @throws WxErrorException
202
+ */
203
+ public boolean materialDelete (String media_id ) throws WxErrorException ;
204
+
205
+ /**
206
+ * <pre>
207
+ * 获取各类素材总数
208
+ *
209
+ * 详情请见: http://mp.weixin.qq.com/wiki/16/8cc64f8c189674b421bee3ed403993b8.html
210
+ * </pre>
211
+ * @return
212
+ * @throws WxErrorException
213
+ */
214
+ public WxMpMaterialCountResult materialCount () throws WxErrorException ;
215
+
216
+ /**
217
+ * <pre>
218
+ * 分页获取图文素材列表
219
+ *
220
+ * 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
221
+ * </pre>
222
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
223
+ * @param count 返回素材的数量,取值在1到20之间
224
+ * @return
225
+ * @throws WxErrorException
226
+ */
227
+ public WxMpMaterialNewsBatchGetResult materialNewsBatchGet (int offset , int count ) throws WxErrorException ;
228
+
229
+ /**
230
+ * <pre>
231
+ * 分页获取其他媒体素材列表
232
+ *
233
+ * 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
234
+ * </pre>
235
+ * @param type 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
236
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
237
+ * @param count 返回素材的数量,取值在1到20之间
238
+ * @return
239
+ * @throws WxErrorException
240
+ */
241
+ public WxMpMaterialFileBatchGetResult materialFileBatchGet (String type , int offset , int count ) throws WxErrorException ;
242
+
114
243
/**
115
244
* @see #mediaUpload(String, String, InputStream)
116
245
* @param mediaType
117
246
* @param file
118
247
* @throws WxErrorException
119
248
*/
120
249
public WxMediaUploadResult mediaUpload (String mediaType , File file ) throws WxErrorException ;
121
-
250
+
122
251
/**
123
252
* <pre>
124
253
* 下载多媒体文件
@@ -130,7 +259,7 @@ public interface WxMpService {
130
259
* @throws WxErrorException
131
260
*/
132
261
public File mediaDownload (String media_id ) throws WxErrorException ;
133
-
262
+
134
263
/**
135
264
* <pre>
136
265
* 发送客服消息
@@ -140,11 +269,11 @@ public interface WxMpService {
140
269
* @throws WxErrorException
141
270
*/
142
271
public void customMessageSend (WxMpCustomMessage message ) throws WxErrorException ;
143
-
272
+
144
273
/**
145
274
* <pre>
146
- * 上传群发用的图文消息,上传后才能群发图文消息
147
- *
275
+ * 上传群发用的图文消息,上传后才能群发图文消息
276
+ *
148
277
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
149
278
* </pre>
150
279
* @param news
@@ -153,7 +282,7 @@ public interface WxMpService {
153
282
* @see #massOpenIdsMessageSend(me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage)
154
283
*/
155
284
public WxMpMassUploadResult massNewsUpload (WxMpMassNews news ) throws WxErrorException ;
156
-
285
+
157
286
/**
158
287
* <pre>
159
288
* 上传群发用的视频,上传后才能群发视频消息
@@ -175,10 +304,10 @@ public interface WxMpService {
175
304
* </pre>
176
305
* @param message
177
306
* @throws WxErrorException
178
- * @return
307
+ * @return
179
308
*/
180
309
public WxMpMassSendResult massGroupMessageSend (WxMpMassGroupMessage message ) throws WxErrorException ;
181
-
310
+
182
311
/**
183
312
* <pre>
184
313
* 按openId列表群发消息
@@ -201,7 +330,7 @@ public interface WxMpService {
201
330
* @throws WxErrorException
202
331
*/
203
332
public void menuCreate (WxMenu menu ) throws WxErrorException ;
204
-
333
+
205
334
/**
206
335
* <pre>
207
336
* 自定义菜单删除接口
@@ -210,7 +339,7 @@ public interface WxMpService {
210
339
* @throws WxErrorException
211
340
*/
212
341
public void menuDelete () throws WxErrorException ;
213
-
342
+
214
343
/**
215
344
* <pre>
216
345
* 自定义菜单查询接口
@@ -227,11 +356,11 @@ public interface WxMpService {
227
356
* 最多支持创建500个分组
228
357
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
229
358
* </pre>
230
- * @param name 分组名字(30个字符以内)
359
+ * @param name 分组名字(30个字符以内)
231
360
* @throws WxErrorException
232
361
*/
233
362
public WxMpGroup groupCreate (String name ) throws WxErrorException ;
234
-
363
+
235
364
/**
236
365
* <pre>
237
366
* 分组管理接口 - 查询所有分组
@@ -241,34 +370,34 @@ public interface WxMpService {
241
370
* @throws WxErrorException
242
371
*/
243
372
public List <WxMpGroup > groupGet () throws WxErrorException ;
244
-
373
+
245
374
/**
246
375
* <pre>
247
376
* 分组管理接口 - 查询用户所在分组
248
377
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
249
378
* </pre>
250
- * @param openid 微信用户的openid
379
+ * @param openid 微信用户的openid
251
380
* @throws WxErrorException
252
381
*/
253
382
public long userGetGroup (String openid ) throws WxErrorException ;
254
-
383
+
255
384
/**
256
385
* <pre>
257
386
* 分组管理接口 - 修改分组名
258
387
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
259
- *
388
+ *
260
389
* 如果id为0(未分组),1(黑名单),2(星标组),或者不存在的id,微信会返回系统繁忙的错误
261
390
* </pre>
262
- * @param group 要更新的group,group的id,name必须设置
391
+ * @param group 要更新的group,group的id,name必须设置
263
392
* @throws WxErrorException
264
393
*/
265
394
public void groupUpdate (WxMpGroup group ) throws WxErrorException ;
266
-
395
+
267
396
/**
268
397
* <pre>
269
398
* 分组管理接口 - 移动用户分组
270
399
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
271
- *
400
+ *
272
401
* 如果to_groupid为0(未分组),1(黑名单),2(星标组),或者不存在的id,微信会返回系统繁忙的错误
273
402
* </pre>
274
403
* @param openid 用户openid
@@ -294,7 +423,7 @@ public interface WxMpService {
294
423
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息
295
424
* </pre>
296
425
* @param openid 用户openid
297
- * @param lang 语言,zh_CN 简体(默认),zh_TW 繁体,en 英语
426
+ * @param lang 语言,zh_CN 简体(默认),zh_TW 繁体,en 英语
298
427
* @return
299
428
* @throws WxErrorException
300
429
*/
@@ -577,7 +706,7 @@ public interface WxMpService {
577
706
* @param outTradeNo
578
707
*/
579
708
WxMpPayResult getJSSDKPayResult (String transactionId , String outTradeNo );
580
-
709
+
581
710
/**
582
711
* 读取支付结果通知
583
712
* 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7
0 commit comments