开放能力
API 总览
易聊提供 REST、WebSocket、Webhook 等接口，助力开发者快速将即时通讯能力集成到自有应用中。
接口
已实现能力
以下接口均已上线并稳定运行，开发者可直接集成使用。
JWT
鉴权与账号
账号体系支持验证码登录、密码登录、注册、登出、用户资料、头像、个人信息查询与修改。
- POST /api/v1/auth/login
- POST /api/v1/auth/register
- GET /api/v1/user/profile
- PUT /api/v1/user/profile
REST
好友与通讯录
支持搜索用户、发起添加好友、同意/拒绝申请、好友列表、拉黑、备注、通讯录管理。
- GET /api/v1/friends
- POST /api/v1/friends/request
- PUT /api/v1/friends/respond
- DELETE /api/v1/friends/{uid}
REST
单聊与群聊
创建群组、邀请成员、群设置、群公告、消息发送、文件上传、聊天记录查询、权限管控。
- POST /api/v1/groups/create
- GET /api/v1/groups/{id}/messages
- POST /api/v1/messages/send
- POST /api/v1/files/upload
WS
WebSocket 实时事件
长连接推送私聊消息、群消息、好友在线状态、入群通知、成员变动、消息撤回事件。
- wss://im.example.com/ws/session/{uid}
- wss://im.example.com/ws/presence
- 消息送达回执
- 在线状态推送
HOOK
Webhook 与开放平台
消息回调、文件上传完成通知已开放。API密钥、企业互通、第三方应用接入将分版本上线。
- 消息回调通知
- 文件上传完成通知
- API Key 管理
- 企业 SSO