Chat Server API 操作

备注:密钥仅在浏览器端存储,易源不做转发

功能示例

创建团队项目对话

输入

  • • 参与者: 张三(1001), 李四(1002), 王五(1003)
  • • 对话类型: 群组对话
  • • 对话名称: Q4产品迭代讨论组

输出

  • • 对话ID: G-20241001
  • • 参与者: 张三、李四、王五
  • • 状态: 创建成功

发送项目进度消息

输入

  • • 目标对话: Q4产品迭代讨论组
  • • 消息内容: "UI设计稿已上传至共享文件夹"
  • • 标记已读: 是

输出

  • • 消息内容: UI设计稿已上传至共享文件夹
  • • 发送状态: 成功发送
  • • 已读状态: 等待接收方确认

查看未读消息总数

输入

  • • 用户对话范围: 我的所有对话

输出

  • • 未读消息总数: 8条
  • • 最近未读对话: Q4产品迭代讨论组(5条)
  • • 客户反馈群(3条)

更新对话名称

输入

  • • 原对话: Q4产品迭代讨论组
  • • 新对话名称: 2024Q4产品上线准备组

输出

  • • 更新后名称: 2024Q4产品上线准备组
  • • 更新时间: 2024-10-15 14:30
  • • 参与者列表: 张三、李四、王五

获取对话历史消息

输入

  • • 目标对话: 2024Q4产品上线准备组
  • • 消息条数: 最近3条

输出

  • • 张三(10:00): "后端接口文档已更新至v2.0"
  • • 李四(11:15): "测试用例初稿完成,链接:xxx"
  • • 王五(14:30): "UI设计稿已上传至共享文件夹"

删除过期对话

输入

  • • 待删除对话: 2023年度总结群
  • • 删除范围: 仅自己可见

输出

  • • 删除状态: 成功删除
  • • 操作提示: 该对话已从您的列表中移除
  • • 其他参与者可见性不变

使用场景

团队协作聊天

为团队提供实时沟通平台,支持多人协作、文件共享和消息历史记录,提升团队工作效率。

客户服务沟通

集成到客户服务系统,实现客服与客户的实时对话,提供即时支持和问题解决方案。

社交应用消息

为社交平台提供稳定可靠的聊天功能,支持单聊、群聊和实时消息推送,增强用户互动体验。

项目管理讨论

在项目管理工具中集成聊天功能,方便团队成员讨论项目进度、分配任务和解决问题。

在线教育互动

为在线教育平台提供师生互动和学生间讨论功能,支持课堂问答和课后交流。

游戏内实时聊天

为游戏应用添加实时聊天功能,支持玩家间交流、组队协作和游戏内公告推送。

价格说明

价格由API服务商设定,请到服务商官网查看详细定价方案。

查看官方价格

常见问题

Chat Server API支持哪些聊天类型?

API支持三种聊天类型:公共群组(PUBLIC_GROUP)、私有群组(GROUP)和私聊(PRIVATE)。您可以根据应用需求选择合适的聊天类型,灵活配置不同的访问权限和功能。

如何实现用户认证和授权?

API通过Users模块实现无缝单点登录授权。您需要获取用户的会话令牌(QB-Token),并在API请求头中包含该令牌进行身份验证。此外,还支持使用API密钥进行应用级别的授权。

消息推送通知如何设置?

您可以使用API的通知设置功能,为每个对话框单独配置离线消息推送通知的开启或关闭状态。支持按用户自定义通知偏好,提升用户体验。

如何处理消息的已读状态?

API提供了更新消息状态的功能,支持将消息标记为已送达或已读。您可以通过设置delivered和read参数来更新消息状态,并获取已读/未读消息统计。

是否支持文件附件功能?

是的,API通过Content模块支持文件附件功能。您可以在消息中添加图片、文档等文件附件,实现丰富的媒体内容分享。文件大小和类型限制请参考官方文档。

如何获取历史聊天记录?

您可以使用"获取消息"API,通过指定对话框ID和分页参数(limit和skip)来检索历史聊天记录。支持按时间排序和自定义查询条件,方便实现消息历史功能。