me.chanjar.weixin.cp.api

接口 WxCpMessageService

所有已知实现类:

WxCpMessageServiceImpl

public interface WxCpMessageService

消息推送接口.

作者:

Binary Wang created on 2020 -08-30

方法概要

限定符和类型	方法和说明
WxCpMessageSendStatistics	getStatistics(int timeType) 查询应用消息发送统计 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/message/get_statistics?
void	recall(String msgId) 撤回应用消息 请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/recall?
WxCpMessageSendResult	send(WxCpMessage message) 发送消息 详情请见: https://work.weixin.qq.com/api/doc/90000/90135/90236
WxCpLinkedCorpMessageSendResult	sendLinkedCorpMessage(WxCpLinkedCorpMessage message) 互联企业的应用支持推送文本、图片、视频、文件、图文等类型。
WxCpSchoolContactMessageSendResult	sendSchoolContactMessage(WxCpSchoolContactMessage message) 发送「学校通知」 https://developer.work.weixin.qq.com/document/path/92321 学校可以通过此接口来给家长发送不同类型的学校通知，来满足多种场景下的学校通知需求。

方法详细资料

send

WxCpMessageSendResult send(WxCpMessage message)
                    throws WxErrorException

 发送消息
 详情请见: https://work.weixin.qq.com/api/doc/90000/90135/90236
 

参数:

message - 要发送的消息对象

返回:

the wx cp message send result

抛出:

WxErrorException - the wx error exception

getStatistics

WxCpMessageSendStatistics getStatistics(int timeType)
                                 throws WxErrorException

 查询应用消息发送统计
 请求方式：POST（HTTPS）
 请求地址：https://qyapi.weixin.qq.com/cgi-bin/message/get_statistics?access_token=ACCESS_TOKEN

 详情请见: https://work.weixin.qq.com/api/doc/90000/90135/92369
 

参数:

timeType - 查询哪天的数据，0：当天；1：昨天。默认为0。

返回:

统计结果 statistics

抛出:

WxErrorException - the wx error exception

sendLinkedCorpMessage

WxCpLinkedCorpMessageSendResult sendLinkedCorpMessage(WxCpLinkedCorpMessage message)
                                               throws WxErrorException

 互联企业的应用支持推送文本、图片、视频、文件、图文等类型。

 请求地址：https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/message/send?access_token=ACCESS_TOKEN
 文章地址：https://work.weixin.qq.com/api/doc/90000/90135/90250
 

参数:

message - 要发送的消息对象

返回:

the wx cp message send result

抛出:

WxErrorException - the wx error exception

sendSchoolContactMessage

WxCpSchoolContactMessageSendResult sendSchoolContactMessage(WxCpSchoolContactMessage message)
                                                     throws WxErrorException

发送「学校通知」 https://developer.work.weixin.qq.com/document/path/92321

学校可以通过此接口来给家长发送不同类型的学校通知，来满足多种场景下的学校通知需求。目前支持的消息类型为文本、图片、语音、视频、文件、图文。

请求方式：POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/externalcontact/message/send?access_token=ACCESS_TOKEN

参数:

message - 要发送的消息对象

返回:

wx cp school contact message send result

抛出:

WxErrorException - the wx error exception

recall

void recall(String msgId)
     throws WxErrorException

 撤回应用消息

 请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/recall?access_token=ACCESS_TOKEN
 文档地址: https://developer.work.weixin.qq.com/document/path/94867
 

参数:

msgId - 消息id

抛出:

WxErrorException