聆客开放平台

# 群添加成员事件

用户加入群组时触发

# 事件定义

定义 .
事件类型code uam:group:member:add

# 事件体

属性名 数据类型 属性说明
version string 事件协议版本,默认1.0
headers 事件头
    ∟ id string 事件id(可基于此id去重,避免业务数据重复),默认uuid
    ∟ code string 事件类型code
    ∟ time string 事件发生时间
    ∟ eCode string 事件体对应租户编码
payload 事件载体
    ∟ groupId string 群组id
    ∟ users 入群的用户列表
        ∟ userId string 用户id
        ∟ userName string 用户名称
        ∟ memRole integer 群成员角色(0:普通成员,1:管理员,2:群主)
    ∟ operator 操作者
        ∟ userId string 操作者用户id
        ∟ userName string 操作者用户名称
        ∟ eCode string 操作者租户编码

# 事件体示例

{
  "version": "1.0", 
  "headers": {
    "id": "a120f23b-4aad-40d1-b04e-38a122b5dd30", 
    "code": "uam:group:member:add", 
    "time": 1655177268672, 
    "eCode": "bingo"
  }, 
  "payload": {
    "groupId": "f1288e4f-ce3d-47bd-bf5b-3712c0d070ee", 
    "users": [
      {
        "userName": "用户1", 
        "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876",
        "memRole": 0
      }
    ], 
    "operator": {
      "userName": "用户1", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876", 
      "eCode": "bingo"
    }
  }
}

# 群成员退出事件

用户退出群组时触发

# 事件定义

定义 .
事件类型code uam:group:member:delete

# 事件体

属性名 数据类型 属性说明
version string 事件协议版本,默认1.0
headers 事件头
    ∟ id string 事件id(可基于此id去重,避免业务数据重复),默认uuid
    ∟ code string 事件类型code
    ∟ time string 事件发生时间,时间戳(毫秒)
    ∟ eCode string 事件体对应租户编码
payload 事件载体
    ∟ groupId string 群组id
    ∟ users 退群的用户列表
        ∟ userId string 用户id
        ∟ userName string 用户名称
    ∟ operator 操作者
        ∟ userId string 操作者用户id
        ∟ userName string 操作者用户名称
        ∟ eCode string 操作者租户编码

# 事件体示例

{
  "version": "1.0", 
  "headers": {
    "id": "a120f23b-4aad-40d1-b04e-38a122b5dd30", 
    "code": "uam:group:member:delete", 
    "time": 1655177268672, 
    "eCode": "bingo"
  }, 
  "payload": {
    "groupId": "f1288e4f-ce3d-47bd-bf5b-3712c0d070ee", 
    "users": [
      {
        "userName": "用户1", 
        "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876"
      }
    ], 
    "operator": {
      "userName": "用户1", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876", 
      "eCode": "bingo"
    }
  }
}

# 群管理员变更事件

设置群组管理员时触发

# 事件定义

定义 .
事件类型code uam:group:member:admin:reset

# 事件体

属性名 数据类型 属性说明
version string 事件协议版本,默认1.0
headers 事件头
    ∟ id string 事件id(可基于此id去重,避免业务数据重复),默认uuid
    ∟ code string 事件类型code
    ∟ time string 事件发生时间,时间戳(毫秒)
    ∟ eCode string 事件体对应租户编码
payload 事件载体
    ∟ groupId string 群组id
    ∟ users 添加的管理员用户列表
        ∟ userId string 用户id
        ∟ userName string 用户名称
    ∟ canceledUsers 取消的管理员用户列表
        ∟ userId string 用户id
        ∟ userName string 用户名称
    ∟ operator 操作者
        ∟ userId string 操作者用户id
        ∟ userName string 操作者用户名称
        ∟ eCode string 操作者租户编码

# 事件体示例

{
  "version": "1.0", 
  "headers": {
    "id": "501b4e05-2c03-4306-8426-7fd6912d70b1", 
    "code": "uam:group:member:admin:reset",  
    "time": 1655199443029,
    "eCode": "bingo"
  }, 
  "payload": {
    "groupId": "43f012d9-0f6a-4239-bcec-3444d5735f23", 
    "users": [
      {
        "userName": "用户2", 
        "userId": "cd8d45bf-6412-11e4-96de-d00dad301b6f"
      }
    ], 
    "canceledUsers": [
      {
        "userName": "用户1", 
        "userId": "dc0668a6-ebc5-11ec-bc09-962ad0356307"
      }
    ], 
    "operator": {
      "userName": "用户2", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876", 
      "eCode": "bingo"
    }
  }
}

# 群主变更事件

群主移交群时触发

# 事件定义

定义 .
事件类型code uam:group:member:owner:change

# 事件体

属性名 数据类型 属性说明
version string 事件协议版本,默认1.0
headers 事件头
    ∟ id string 事件id(可基于此id去重,避免业务数据重复),默认uuid
    ∟ code string 事件类型code
    ∟ time string 事件发生时间,时间戳(毫秒)
    ∟ eCode string 事件体对应租户编码
payload 事件载体
    ∟ groupId string 群组id
    ∟ owner 新群主
        ∟ userId string 用户id
        ∟ userName string 用户名称
    ∟ oldOwner 上任群主
        ∟ userId string 用户id
        ∟ userName string 用户名称
    ∟ operator 操作者
        ∟ userId string 操作者用户id
        ∟ userName string 操作者用户名称
        ∟ eCode string 操作者租户编码

# 事件体示例

{
  "version": "1.0", 
  "headers": {
    "id": "4d556395-6e09-4814-9ff9-9e77044d483d", 
    "code": "uam:group:member:owner:change", 
    "time": 1655199209235, 
    "eCode": "bingo"
  }, 
  "payload": {
    "groupId": "63d49f34-d95e-4398-9bb4-4497e75413eb",
    "owner": {
      "userName": "用户1", 
      "userId": "cd8d45bf-6412-11e4-96de-d00dad301b6f"
    }, 
    "oldOwner": {
      "userName": "用户2", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876"
    }, 
    "operator": {
      "userName": "用户2", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876", 
      "eCode": "bingo"
    }
  }
}

# 群组解散事件

群主解散群组时触发

# 事件定义

定义 .
事件类型code uam:group:dismiss

# 事件体

属性名 数据类型 属性说明
version string 事件协议版本,默认1.0
headers 事件头
    ∟ id string 事件id(可基于此id去重,避免业务数据重复),默认uuid
    ∟ code string 事件类型code
    ∟ time string 事件发生时间,时间戳(毫秒)
    ∟ eCode string 事件体对应租户编码
payload 事件载体
    ∟ groupId string 群组id
    ∟ operator 操作者
        ∟ userId string 操作者用户id
        ∟ userName string 操作者用户名称
        ∟ eCode string 操作者租户编码

# 事件体示例

{
  "version": "1.0", 
  "headers": {
    "id": "4d556395-6e09-4814-9ff9-9e77044d483d", 
    "code": "uam:group:dismiss", 
    "time": 1655199209235, 
    "eCode": "bingo"
  }, 
  "payload": {
    "groupId": "63d49f34-d95e-4398-9bb4-4497e75413eb",
    "operator": {
      "userName": "用户2", 
      "userId": "43fe6476-cd7b-493b-8044-c7e3149d0876", 
      "eCode": "bingo"
    }
  }
}