me.chanjar.weixin.cp.tp.service

接口 WxCpTpMessageService

所有已知实现类:

WxCpTpMessageServiceImpl

public interface WxCpTpMessageService

企业微信第三方应用消息推送接口.

第三方应用使用授权企业的 access_token 代表授权企业发送应用消息。

作者:

GitHub Copilot

方法概要

限定符和类型	方法和说明
WxCpMessageSendStatistics	getStatistics(int timeType, String corpId) 查询应用消息发送统计.
void	recall(String msgId, String corpId) 撤回应用消息.
WxCpMessageSendResult	send(WxCpMessage message, String corpId) 发送应用消息（代授权企业发送）.
WxCpLinkedCorpMessageSendResult	sendLinkedCorpMessage(WxCpLinkedCorpMessage message, String corpId) 互联企业发送应用消息.
WxCpSchoolContactMessageSendResult	sendSchoolContactMessage(WxCpSchoolContactMessage message, String corpId) 发送「学校通知」.

方法详细资料

send

WxCpMessageSendResult send(WxCpMessage message,
                           String corpId)
                    throws WxErrorException

 发送应用消息（代授权企业发送）.
 详情请见: https://work.weixin.qq.com/api/doc/90000/90135/90236
 

参数:

message - 要发送的消息对象

corpId - 授权企业的 corpId

返回:

消息发送结果

抛出:

WxErrorException - 微信错误异常

getStatistics

WxCpMessageSendStatistics getStatistics(int timeType,
                                        String corpId)
                                 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。

corpId - 授权企业的 corpId

返回:

统计结果

抛出:

WxErrorException - 微信错误异常

sendLinkedCorpMessage

WxCpLinkedCorpMessageSendResult sendLinkedCorpMessage(WxCpLinkedCorpMessage message,
                                                      String corpId)
                                               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 - 要发送的消息对象

corpId - 授权企业的 corpId

返回:

消息发送结果

抛出:

WxErrorException - 微信错误异常

sendSchoolContactMessage

WxCpSchoolContactMessageSendResult sendSchoolContactMessage(WxCpSchoolContactMessage message,
                                                            String corpId)
                                                     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 - 要发送的消息对象

corpId - 授权企业的 corpId

返回:

消息发送结果

抛出:

WxErrorException - 微信错误异常

recall

void recall(String msgId,
            String corpId)
     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

corpId - 授权企业的 corpId

抛出:

WxErrorException - 微信错误异常