WSS 消息体

当前支持的事件

  1. // 事件类型
  2. const (
  3.     EventGuildCreate           EventType = "GUILD_CREATE"
  4.     EventGuildUpdate           EventType = "GUILD_UPDATE"
  5.     EventGuildDelete           EventType = "GUILD_DELETE"
  6.     EventChannelCreate         EventType = "CHANNEL_CREATE"
  7.     EventChannelUpdate         EventType = "CHANNEL_UPDATE"
  8.     EventChannelDelete         EventType = "CHANNEL_DELETE"
  9.     EventGuildMemberAdd        EventType = "GUILD_MEMBER_ADD"
  10.     EventGuildMemberUpdate     EventType = "GUILD_MEMBER_UPDATE"
  11.     EventGuildMemberRemove     EventType = "GUILD_MEMBER_REMOVE"
  12.     EventMessageCreate         EventType = "MESSAGE_CREATE"
  13.     EventMessageReactionAdd    EventType = "MESSAGE_REACTION_ADD"
  14.     EventMessageReactionRemove EventType = "MESSAGE_REACTION_REMOVE"
  15.     EventAtMessageCreate       EventType = "AT_MESSAGE_CREATE"
  16.     EventPublicMessageDelete   EventType = "PUBLIC_MESSAGE_DELETE"
  17.     EventDirectMessageCreate   EventType = "DIRECT_MESSAGE_CREATE"
  18.     EventDirectMessageDelete   EventType = "DIRECT_MESSAGE_DELETE"
  19.     EventAudioStart            EventType = "AUDIO_START"
  20.     EventAudioFinish           EventType = "AUDIO_FINISH"
  21.     EventAudioOnMic            EventType = "AUDIO_ON_MIC"
  22.     EventAudioOffMic           EventType = "AUDIO_OFF_MIC"
  23.     EventMessageAuditPass      EventType = "MESSAGE_AUDIT_PASS"
  24.     EventMessageAuditReject    EventType = "MESSAGE_AUDIT_REJECT"
  25.     EventMessageDelete         EventType = "MESSAGE_DELETE"
  26.     EventForumThreadCreate     EventType = "FORUM_THREAD_CREATE"
  27.     EventForumThreadUpdate     EventType = "FORUM_THREAD_UPDATE"
  28.     EventForumThreadDelete     EventType = "FORUM_THREAD_DELETE"
  29.     EventForumPostCreate       EventType = "FORUM_POST_CREATE"
  30.     EventForumPostDelete       EventType = "FORUM_POST_DELETE"
  31.     EventForumReplyCreate      EventType = "FORUM_REPLY_CREATE"
  32.     EventForumReplyDelete      EventType = "FORUM_REPLY_DELETE"
  33.     EventForumAuditResult      EventType = "FORUM_PUBLISH_AUDIT_RESULT"
  34.     EventInteractionCreate     EventType = "INTERACTION_CREATE"
  35. )

当前事件的返回类型

  1. // ReadyHandler 可以处理 ws 的 ready 事件
  2. type ReadyHandler func(event *dto.WSPayload, data *dto.WSReadyData)
  4. // ErrorNotifyHandler 当 ws 连接发生错误的时候，会回调，方便使用方监控相关错误
  5. // 比如 reconnect invalidSession 等错误，错误可以转换为 bot.Err
  6. type ErrorNotifyHandler func(err error)
  8. // PlainEventHandler 透传handler
  9. type PlainEventHandler func(event *dto.WSPayload, message []byte) error
  11. // GuildEventHandler 频道事件handler
  12. type GuildEventHandler func(event *dto.WSPayload, data *dto.WSGuildData) error
  14. // GuildMemberEventHandler 频道成员事件 handler
  15. type GuildMemberEventHandler func(event *dto.WSPayload, data *dto.WSGuildMemberData) error
  17. // ChannelEventHandler 子频道事件 handler
  18. type ChannelEventHandler func(event *dto.WSPayload, data *dto.WSChannelData) error
  20. // MessageEventHandler 消息事件 handler
  21. type MessageEventHandler func(event *dto.WSPayload, data *dto.WSMessageData) error
  23. // MessageDeleteEventHandler 消息事件 handler
  24. type MessageDeleteEventHandler func(event *dto.WSPayload, data *dto.WSMessageDeleteData) error
  26. // PublicMessageDeleteEventHandler 消息事件 handler
  27. type PublicMessageDeleteEventHandler func(event *dto.WSPayload, data *dto.WSPublicMessageDeleteData) error
  29. // DirectMessageDeleteEventHandler 消息事件 handler
  30. type DirectMessageDeleteEventHandler func(event *dto.WSPayload, data *dto.WSDirectMessageDeleteData) error
  32. // MessageReactionEventHandler 表情表态事件 handler
  33. type MessageReactionEventHandler func(event *dto.WSPayload, data *dto.WSMessageReactionData) error
  35. // ATMessageEventHandler at 机器人消息事件 handler
  36. type ATMessageEventHandler func(event *dto.WSPayload, data *dto.WSATMessageData) error
  38. // DirectMessageEventHandler 私信消息事件 handler
  39. type DirectMessageEventHandler func(event *dto.WSPayload, data *dto.WSDirectMessageData) error
  41. // AudioEventHandler 音频机器人事件 handler
  42. type AudioEventHandler func(event *dto.WSPayload, data *dto.WSAudioData) error
  44. // MessageAuditEventHandler 消息审核事件 handler
  45. type MessageAuditEventHandler func(event *dto.WSPayload, data *dto.WSMessageAuditData) error
  47. // ThreadEventHandler 论坛主题事件 handler
  48. type ThreadEventHandler func(event *dto.WSPayload, data *dto.WSThreadData) error
  50. // PostEventHandler 论坛回帖事件 handler
  51. type PostEventHandler func(event *dto.WSPayload, data *dto.WSPostData) error
  53. // ReplyEventHandler 论坛帖子回复事件 handler
  54. type ReplyEventHandler func(event *dto.WSPayload, data *dto.WSReplyData) error
  56. // ForumAuditEventHandler 论坛帖子审核事件 handler
  57. type ForumAuditEventHandler func(event *dto.WSPayload, data *dto.WSForumAuditData) error
  59. // InteractionEventHandler 互动事件 handler
  60. type InteractionEventHandler func(event *dto.WSPayload, data *dto.WSInteractionData) error

使用示例

创建 WSS 实例并监听消息

  1. func main() {
  2.     token := token.BotToken(config.AppID, config.Token) //生成token
  3.     api = botgo.NewOpenAPI(token).WithTimeout(3 * time.Second)
  4.     ctx = context.Background()
  5.     ws, _ := api.WS(ctx, nil, "") //websocket
  7.     var atMessage event.ATMessageEventHandler = atMessageEventHandler //@事件处理
  8.     intent := websocket.RegisterHandlers(atMessage)                   // 注册socket消息处理
  9.     botgo.NewSessionManager().Start(ws, token, &intent)               // 启动socket监听
  10. }
  12. func atMessageEventHandler(event *dto.WSPayload, data *dto.WSATMessageData) error {
  13.     message, err := api.PostMessage(ctx, channelId, &dto.MessageToCreate{
  14.         MsgID:   msgId, //如果未空则表示主动消息
  15.         Content: "hello world",
  16.     })
  17.     if err != nil {
  18.         log.Fatalln("调用 PostMessage 接口失败, err = ", err)
  19.     }
  20.     log.Println(message)
  21.     return nil
  22. }

如果同时需要监听多个事件，在listen_events增加多个事件的handler对象

  1. //同时监听at消息和私信消息的事件
  2. var atMessage event.ATMessageEventHandler = atMessageEventHandler //@事件处理
  3. var directMessage event.DirectMessageEventHandler = directMessageEventHandler//私信事件处理
  5. intent := websocket.RegisterHandlers(atMessage, directMessage)                   // 注册socket消息处理
  6. botgo.NewSessionManager().Start(ws, token, &intent)               // 启动socket监听