Box IM Python SDK

完整规范的即时通讯开发工具包，支持用户登录、消息收发、群组管理、文件上传、WebRTC音视频通话等功能

立即下载 查看文档

当前最新版本: v1.0.0

功能特性

🔐 用户认证

支持账号密码登录、注册、Token刷新、密码修改等完整的用户认证功能

💬 消息管理

支持私聊和群聊消息的发送、接收、撤回、历史查询，支持多种消息类型

👥 群组管理

支持群组的创建、修改、解散、成员管理等完整的群组功能

📁 文件上传

支持图片和文件的上传功能，方便分享和传输数据

🔌 WebSocket

实时消息推送，确保消息及时到达

📹 WebRTC

支持音视频通话功能，包括呼叫、接听、拒绝、挂断等操作

快速开始

import asyncio
from box_im_bot_sdk import BoxIMBotSDK, BotConfig

async def main():
    # 配置SDK
    config = BotConfig(
        api_base_url='https://www.boxim.online',
        ws_url='wss://www.boxim.online'
    )
    
    # 创建SDK实例
    sdk = BoxIMBotSDK(config)
    
    # 用户账号密码登录
    login_result = await sdk.start_with_password('username', 'password')
    print(f"登录成功: {login_result.user.nickname}")
    
    # 发送私聊消息
    message = await sdk.send_message('target_id', 'Hello World!')
    print(f"消息发送成功: {message.id}")

if __name__ == '__main__':
    asyncio.run(main())

最近更新

v1.0.0 - Initial Release

2026-05-21
  • 初始版本发布
  • 实现全部52个API接口
  • 支持用户账号密码登录、注册、Token刷新
  • 支持私聊和群聊消息收发、撤回、历史查询
  • 支持群组创建、管理、成员操作
  • 支持好友添加、删除、在线状态查询
  • 支持文件和图片上传
  • 支持WebRTC音视频通话

查看全部更新

技术架构

BoxIMBotSDK ├── HttpClient # HTTP请求客户端 ├── WebSocketClient # WebSocket实时通信 ├── MessageManager # 消息管理器 ├── GroupManager # 群组管理器 ├── UserManager # 用户管理器 ├── FileManager # 文件管理器 └── WebRTCManager # 音视频通话管理器

SDK采用模块化设计，各个管理器职责清晰，便于扩展和维护