cn.byteforge.openqq.http

Class OpenAPI

java.lang.Object

cn.byteforge.openqq.http.OpenAPI

public class OpenAPI
extends java.lang.Object

QQ 机器人 服务端开放的 openapi 接口对接

Constructor Summary

Constructors

Constructor and Description
OpenAPI()

Method Summary

Modifier and Type	Method and Description
static void	addBeforeGetAuthResponseCheck(APIEnum apiEnum, java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,java.lang.Boolean> checkFunc) 添加全局发送数据前预检查方法
static void	callbackInteraction(java.lang.String interactionId, InteractResult result, Certificate cert) 回调 QQ 后台，告知交互事件已经收到
static AccessToken	getAppAccessToken(java.lang.String appId, java.lang.String clientSecret) 获取调用凭证
static RecommendShard	getRecommendShardWssUrls(Certificate cert) 获取带推荐分片数的 WSS 接入点
static java.lang.String	getUniversalWssUrl(Certificate cert) 获取通用 WSS 接入点
static MessageResponse	sendGroupMessage(java.lang.String groupId, Message message, Certificate cert) 发送群聊消息
static FileInfo	uploadGroupFile(java.lang.String groupId, java.lang.String url, boolean send, UploadFileType type, Certificate cert) 上传文件到群组
static FileInfo	uploadPrivateFile(java.lang.String userId, java.lang.String url, boolean send, UploadFileType type, Certificate cert) 上传文件到用户

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenAPI

public OpenAPI()

Method Detail

sendGroupMessage

public static MessageResponse sendGroupMessage(java.lang.String groupId,
                                               Message message,
                                               Certificate cert)

发送群聊消息

Parameters:

groupId - 群聊的 openid

message - 消息实例

cert - 访问凭证

uploadPrivateFile

public static FileInfo uploadPrivateFile(java.lang.String userId,
                                         java.lang.String url,
                                         boolean send,
                                         UploadFileType type,
                                         Certificate cert)

上传文件到用户

Parameters:

userId - 用户的 openid

url - 需要发送媒体资源的url

send - 设置 true 会直接发送消息到目标端，且会占用主动消息频次

type - 媒体类型：1 图片，2 视频，3 语音，4 文件（暂不开放） 资源格式要求 图片：png/jpg，视频：mp4，语音：silk

cert - 访问凭证

uploadGroupFile

public static FileInfo uploadGroupFile(java.lang.String groupId,
                                       java.lang.String url,
                                       boolean send,
                                       UploadFileType type,
                                       Certificate cert)

上传文件到群组

Parameters:

groupId - 群聊的 openid

url - 需要发送媒体资源的url

send - 设置 true 会直接发送消息到目标端，且会占用主动消息频次

type - 媒体类型：1 图片，2 视频，3 语音，4 文件（暂不开放） 资源格式要求 图片：png/jpg，视频：mp4，语音：silk

cert - 访问凭证

callbackInteraction

public static void callbackInteraction(java.lang.String interactionId,
                                       InteractResult result,
                                       Certificate cert)

回调 QQ 后台，告知交互事件已经收到

Parameters:

interactionId - 事件 data.id

result - 交互结果

cert - 访问凭证

getAppAccessToken

public static AccessToken getAppAccessToken(java.lang.String appId,
                                            java.lang.String clientSecret)

获取调用凭证

Parameters:

appId - 在开放平台管理端上获得。

clientSecret - 在开放平台管理端上获得。

getUniversalWssUrl

public static java.lang.String getUniversalWssUrl(Certificate cert)

获取通用 WSS 接入点

Parameters:

cert - 访问凭证

getRecommendShardWssUrls

public static RecommendShard getRecommendShardWssUrls(Certificate cert)

获取带推荐分片数的 WSS 接入点

Parameters:

cert - 访问凭证

addBeforeGetAuthResponseCheck

public static void addBeforeGetAuthResponseCheck(APIEnum apiEnum,
                                                 java.util.function.Function<java.util.Map<java.lang.String,java.lang.Object>,java.lang.Boolean> checkFunc)

添加全局发送数据前预检查方法

Parameters:

apiEnum - 准备检查的 API 枚举

checkFunc - 检查方法, <负载数据, 是否通过>