文档帮助平台
首页服务端API参考 事件订阅 IM事件
IM事件
更新时间：2025-01-24 05:43:25

IM事件

机器人接收消息事件

事件描述

  • 事件类型：im.message_receive
  • 事件说明：机器人接收到用户发送的消息后触发此事件，包括机器人单聊消息，群聊@机器人消息

data结构说明

参数 类型 描述
sender Sender 发送者信息
sessionType string 会话类型
message Message 消息内容

Sender对象定义

参数 类型 描述
senderId string 发送者ID
partyId string 企业ID

Message对象定义

参数 类型 描述
sessionId int64 会话ID
parentId int64 原文ID（回复消息时该字段为原文消息ID）
msgId int64 消息ID
msgType string 消息类型
body string 消息内容 参考各类型格式
bornTime int64 消息生成时间
version int64 消息版本号

事件体示例

{
  "events": [
    {
      "createTime": 1702451923243,
      "data": {
        "message": {
          "body": "测试消息",
          "bornTime": 1702451923224,
          "msgId": 592257374169858048,
          "msgType": "text",
          "sessionId": 8027973842749153137
        },
        "sender": {
          "partyId": "23f18533ff57409b9277944fcfb2eb43",
          "senderId": "83ebb17fe5b6489594779e3325d767ad"
        },
        "sessionType": "group"
      },
      "dataVersion": 1,
      "id": "d20ec7e845114cdea05cbb611f32e3a7",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.message_receive",
      "userId": null
    }
  ]
}

消息撤回事件

事件描述

  • 事件类型：im.messageWithdrawn
  • 事件说明：消息被撤回后触发此事件

data结构说明

参数 类型 描述
sessionId int64 会话ID
msgId int64 消息ID
operatorId string 撤回者ID
withdrawnType string 撤回类型
withdrawnTime int64 撤回时间

事件体示例

{
  "events": [
    {
      "createTime": 1702455402065,
      "data": {
        "msgId": 592264647092994048,
        "operatorId": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592079294170660864,
        "withdrawnTime": 1702455402066,
        "withdrawnType": "owner"
      },
      "dataVersion": 1,
      "id": "066d6104c19e4af8b6bee5cb5f857220",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.messageWithdrawn",
      "userId": null
    }
  ]
}

创建机器人单聊会话事件

事件描述

  • 事件类型：im.sessionCreate
  • 事件说明：首次创建用户与机器人的单聊会话，触发事件

data结构说明

参数 类型 描述
sessionId int64 会话ID
userIds string[] 用户ID集合

事件体示例

{
  "events": [
    {
      "createTime": 1702456820881,
      "data": {
        "sessionId": 3907683557215163115,
        "userIds": [
          "83ebb17fe5b6489594779e3325d767ad"
        ]
      },
      "dataVersion": 1,
      "id": "87bdd24e754b4481ba1993e691948b7f",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.sessionCreate",
      "userId": null
    }
  ]
}

群聊解散事件

事件描述

  • 事件类型：im.groupDissolve
  • 事件说明：机器人所在群聊被解散

data结构说明

参数 类型 描述
sessionId int64 会话ID
operatorId string 操作者ID

事件体示例

{
  "events": [
    {
      "createTime": 1702456946072,
      "data": {
        "operatorId": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592267888323723264
      },
      "dataVersion": 1,
      "id": "4d86ed03683442db87dba5249c9e22db",
      "metadataVersion": 1,
      "partyId": null,
      "type": "im.groupDissolve",
      "userId": null
    }
  ]
}

群详情更新事件

事件描述

  • 事件类型：im.groupUpdated
  • 事件说明：群详情被更新，包含群信息、群主、群管理员变更和群设置，仅在对应信息/配置发生变更时才存在对应字段

data结构说明

参数 类型 描述
sessionId int64 会话ID
sessionName string 变更的群名称
icon string 变更的群头像ID
newOwnerId string 转让的群主ID
canceledAdmin string[] 被取消的群管理员ID集合
addedAdmin string[] 被添加的群管理员ID集合
onlyManagerEditInfo boolean 变更配置[仅群主和管理员可编辑群信息]
isPublic boolean 变更配置[群可被搜索]
isPersistent boolean 变更配置[永久群聊]
entryCheck boolean 变更配置[入群验证]
readHistory boolean 变更配置[新成员可查看历史消息]
operatorId string 操作者用户ID

事件体示例

{
  "events": [
    {
      "createTime": 1702458684977,
      "data": {
        "operatorId": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592270055478657024,
        "sessionName": "变更群名称"
      },
      "dataVersion": 1,
      "id": "78062583eeb045ea829090d9d662e1dc",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.groupUpdated",
      "userId": null
    }
  ]
}

群公告被更新事件

事件描述

  • 事件类型：im.sessionNoticeUpdate
  • 事件说明：群公告被更新

data结构说明

参数 类型 描述
sessionId int64 会话ID
oldSessionNotice string 更新前群公告内容
sessionNotice string 更新后群公告内容
operator string 操作者ID

事件体示例

{
  "events": [
    {
      "createTime": 1702458852517,
      "data": {
        "oldSessionNotice": "群公告",
        "operator": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592270055478657024,
        "sessionNotice": "更新群公告"
      },
      "dataVersion": 1,
      "id": "58614d59e71145ba98eed6286a2f74d3",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.sessionNoticeUpdate",
      "userId": null
    }
  ]
}

用户进群事件

事件描述

  • 事件类型：im.groupUserAdded
  • 事件说明：新用户进群触发此事件

data结构说明

参数 类型 描述
sessionId int64 会话ID
userIds string[] 进入群聊的用户ID集合
inviterId string 邀请者用户ID
joinType string 加入群聊类型

事件体示例

{
  "events": [
    {
      "createTime": 1702460314584,
      "data": {
        "joinType": "active",
        "sessionId": 592274863237365760,
        "userIds": [
          "83ebb17fe5b6489594779e3325d767ad"
        ]
      },
      "dataVersion": 1,
      "id": "8a30c66abc75450cb308655f6f54e335",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.groupUserAdded",
      "userId": null
    }
  ]
}

用户出群事件

事件描述

  • 事件类型：im.groupUserDeleted
  • 事件说明：用户主动退群或被移出群聊时推送事件

data结构说明

参数 类型 描述
sessionId int64 会话ID
userIds string[] 退出群聊的用户ID集合
operatorId string 操作者用户ID
leaveType string 退出群聊类型

事件体示例

{
  "events": [
    {
      "createTime": 1702517391972,
      "data": {
        "leaveType": "removed",
        "operatorId": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592270055478657024,
        "userIds": [
          "52e759394a244768ad8ba8e897078a91"
        ]
      },
      "dataVersion": 1,
      "id": "95387ac3e5434ebe916194cb0a252919",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.groupUserDeleted",
      "userId": null
    }
  ]
}

机器人被拉入群事件

事件描述

  • 事件类型：im.groupBotAdded
  • 事件说明：当前机器人被用户添加至群聊时触发此事件，仅会推给指定机器人

data结构说明

参数 类型 描述
sessionId int64 会话ID
botIds string[] 入群的机器人ID集合
inviterId string 邀请者用户ID
joinType string 加入群聊类型

事件体示例

{
  "events": [
    {
      "createTime": 1702518004172,
      "data": {
        "botIds": [
          "77e7b12dde6040d4abf670c8385addf3"
        ],
        "inviterId": "83ebb17fe5b6489594779e3325d767ad",
        "joinType": "invited",
        "sessionId": 592270055478657024
      },
      "dataVersion": 1,
      "id": "06007a3bacbb499696e278f35b2fd895",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.groupBotAdded",
      "userId": null
    }
  ]
}

机器人被移出群事件

事件描述

  • 事件类型：im.groupBotDeleted
  • 事件说明：当前机器人被移出群聊后触发此事件，仅会推给指定机器人

data结构说明

参数 类型 描述
sessionId int64 会话ID
botIds string[] 退群的机器人ID集合
operatorId string 邀请者用户ID

事件体示例

{
  "events": [
    {
      "createTime": 1702518247308,
      "data": {
        "botIds": [
          "a0a105a4082b447d84030da47bf16014"
        ],
        "operatorId": "83ebb17fe5b6489594779e3325d767ad",
        "sessionId": 592270055478657024
      },
      "dataVersion": 1,
      "id": "5fe2854e52b9410fa4e0d463d69fe5a3",
      "metadataVersion": 1,
      "partyId": "23f18533ff57409b9277944fcfb2eb43",
      "type": "im.groupBotDeleted",
      "userId": null
    }
  ]
}
本页目录