API接口文档 (小组级)-新
  1. 群聊接口
API接口文档 (小组级)-新
  • api接入说明
  • 系统使用说明
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管账号列表
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
          POST
        • 退出群聊事件回调
          POST
        • 加入群聊事件回调
          POST
        • 更改群名事件回调
          POST
        • 创建群聊
          POST
        • 通过联系人id获取联系人所在群聊
          GET
      • 会话接口
        • 开发建议
        • 会话超时跟进回调
        • 获取会话ai状态
        • 获取指定会话
        • 会话ai状态切换
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
        • api加好友任务成功回调
        • 好友通过后回调
        • 群聊加好友接口
      • 消息接口
        • 小组级发送消息回调
        • 获取原图
        • 发送消息
        • 小组级接收消息回调
        • 聊天历史
        • im员工id发消息
      • 群发接口
        • 创建群发
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过im群聊id加好友
      • 新增客户
      • 获取成员详情
      • 秒回数据同步
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定im官方ID
      • 通过externalUserId获取chatId
  1. 群聊接口

加入群聊事件回调

POST
/room/joined
⚠重试机制:若回调请求超时,则会重试,最多5次,如果3分钟内有10个回调重试5次全部失败,则禁用回调地址30分钟。
⚠建议收到后回调后进行异步处理,防止处理超时导致我们重复推送。

请求参数

Body 参数application/json

示例
{
    "token": "669dc78a7****23e04351d6",
    "avatarUrl": "https://workmate.s3.cn-northwest-1.amazonaws.com.cn/room_avatar/1c16b66c-8a00-4754-9f64-a1c71c14e863/10882094539049797.png",
    "botInfo": {
        "botId": "66a77970c****6b879ef868",
        "imBotId": "168885****578438",
        "wecomUserId": "zhangsan",
        "nickName": "张三1234"
    },
    "chatId": "685bd3c3e****c8657fb492e",
    "joinedMember": [
        {
            "avatarUrl": "https://wx.qlogo.cn/mmhead/eHEMOF2hOemjL4zQT7rQgicicRibAM6T7RveG2diasqXXNFNFACYibicPf5Ygds0GvpVXLq2CntjP0gfo/0",
            "contactType": 1,
            "coworker": false,
            "isFriend": true,
            "nickName": "f",
            "roomAlias": null,
            "imContactId": "78813****9110143",
            "joinTime": 1752115629,
            "isSelf": false
        }
    ],
    "inviter": {
        "avatarUrl": "https://wework.qpic.cn/wwpic3az/375283_30QqeKdzQkKC_kj_1752047248/0",
        "contactType": 3,
        "coworker": true,
        "isFriend": true,
        "nickName": "张三4321",
        "roomAlias": "马云飞",
        "imContactId": "16888****578438",
        "joinTime": 1750848444,
        "isSelf": true
    },
    "ownerImContactId": "168885****644281",
    "topic": "20250625群聊1-1",
    "imRoomId": "R:108820****9049797",
    "groupId": "64758f02111f3bf9615998f1",
    "timestamp": 1752115635653
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://zan-api.xiaoshunai.com/room/joined' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "669dc78a7****23e04351d6",
    "avatarUrl": "https://workmate.s3.cn-northwest-1.amazonaws.com.cn/room_avatar/1c16b66c-8a00-4754-9f64-a1c71c14e863/10882094539049797.png",
    "botInfo": {
        "botId": "66a77970c****6b879ef868",
        "imBotId": "168885****578438",
        "wecomUserId": "zhangsan",
        "nickName": "张三1234"
    },
    "chatId": "685bd3c3e****c8657fb492e",
    "joinedMember": [
        {
            "avatarUrl": "https://wx.qlogo.cn/mmhead/eHEMOF2hOemjL4zQT7rQgicicRibAM6T7RveG2diasqXXNFNFACYibicPf5Ygds0GvpVXLq2CntjP0gfo/0",
            "contactType": 1,
            "coworker": false,
            "isFriend": true,
            "nickName": "f",
            "roomAlias": null,
            "imContactId": "78813****9110143",
            "joinTime": 1752115629,
            "isSelf": false
        }
    ],
    "inviter": {
        "avatarUrl": "https://wework.qpic.cn/wwpic3az/375283_30QqeKdzQkKC_kj_1752047248/0",
        "contactType": 3,
        "coworker": true,
        "isFriend": true,
        "nickName": "张三4321",
        "roomAlias": "马云飞",
        "imContactId": "16888****578438",
        "joinTime": 1750848444,
        "isSelf": true
    },
    "ownerImContactId": "168885****644281",
    "topic": "20250625群聊1-1",
    "imRoomId": "R:108820****9049797",
    "groupId": "64758f02111f3bf9615998f1",
    "timestamp": 1752115635653
}'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2026-01-20 10:37:44
上一页
退出群聊事件回调
下一页
更改群名事件回调
Built with