即时通信
    即时通信
    • API在线调试指南
    • IM账号管理
      • 注册云信IM账号
        POST
      • 更新账号属性
        PATCH
      • 刷新 Token
        PATCH
      • 封禁账号
        PATCH
      • 更新移动端推送配置
        PATCH
      • 查询账号属性
        GET
      • 批量查询账号信息
        GET
      • 强制账号退出登录
        POST
    • 用户名片管理
      • 更新用户名片
        PATCH
      • 查询用户名片
        GET
      • 批量查询用户名片
        GET
      • 批量获取账号在线状态
        POST
    • 好友管理
      • 添加好友
        POST
      • 删除好友
        DELETE
      • 更新好友信息
        PATCH
      • 查询好友信息
        GET
      • 分页查询好友列表
        GET
      • 同意/拒绝添加好友
        POST
    • 静音管理
      • 分页查询静音列表
        GET
      • 解除静音
        DELETE
      • 设置静音
        POST
    • 黑名单管理
      • 列入黑名单
        POST
      • 移出黑名单
        DELETE
      • 分页查询黑名单列表
        GET
    • 消息管理
      • 发送消息
      • 批量发送单聊消息
      • 撤回/删除消息
      • 删除会话中漫游/历史消息
      • 发送单聊已读回执
      • 发送高级群已读回执
      • 查询群消息已读未读详情
      • 查询单条消息
      • 分页查询历史消息
      • 发送聊天室消息
      • 批量发送聊天室消息
      • 撤回/删除聊天室历史消息
      • 分页查询聊天室历史消息
      • 更新消息
      • 根据消息 ID 查询历史消息
      • 查询 Thread 消息
      • 添加快捷评论
      • 删除快捷评论
      • 查询快捷评论
      • 检索历史消息
      • 发送流式消息
    • 会话功能
      • 会话管理
        • 创建会话
        • 更新会话
        • 删除会话
        • 批量删除会话
        • 查询会话信息
        • 批量查询会话信息
        • 分页查询账号的所有会话列表
      • 会话未读数管理
        • 获取会话总未读数
      • 会话分组
        • 创建会话分组
        • 更新会话分组
        • 删除会话分组
        • 查询会话分组信息
        • 批量查询会话分组信息
        • 查询所有会话分组信息
    • 群组功能
      • 群成员
        • 拉人入群
        • 踢人出群
        • 主动退群
        • 更新群成员信息
        • 批量禁言群成员
        • 分页查询指定账号已加入的群组信息
      • 群组管理
        • 创建群组
        • 更新群组信息
        • 转让群主
        • 添加管理员
        • 移除管理员
        • 解散群组
        • 查询群组信息
        • 批量查询群组信息列表
        • 查询高级群在线成员列表
        • 批量查询高级群的在线成员数
        • 分页查询群成员列表
    • 聊天室功能
      • 聊天室管理
        • 创建聊天室
        • 获取聊天室地址
        • 查询聊天室信息
        • 更新聊天室信息
        • 开放/关闭聊天室
        • 聊天室禁言
        • 开启/关闭进出聊天室事件通知
        • 查询开放状态的聊天室
        • 分页查询聊天室在线成员列表
        • 查询聊天室固定成员列表
      • 聊天室成员
        • 设置聊天室成员角色
        • 更新聊天室在线成员信息
        • 禁言聊天室成员
        • 临时禁言聊天室成员
        • 查询聊天室的禁言列表
        • 拉黑聊天室成员
        • 聊天室标签禁言
        • 查询聊天室黑名单列表
        • 聊天室标签禁言
        • 修改聊天室在线成员标签
        • 查询标签下的在线成员数
        • 分页查询标签下的在线成员列表
        • 批量查询聊天室固定成员信息
        • 添加聊天室虚构用户
        • 删除聊天室虚构用户
        • 清空聊天室虚构用户
        • 查询聊天室虚构用户
      • 聊天室队列
        • 初始化聊天室队列
        • 删除聊天室队列
        • 更新聊天室队列
        • 查询聊天室队列元素
        • 从聊天室队列中取出元素
    • 广播消息管理
      • 发送广播消息
      • 删除广播消息
      • 查询广播消息
      • 分页查询广播消息
      • 发送聊天室全服广播消息
    • 系统通知管理
      • 发送自定义系统通知
      • 批量发送自定义系统通知
    • 发布订阅
      • 订阅在线状态事件
      • 查询在线状态事件订阅关系
      • 取消在线状态事件订阅
    • 翻译
      • 文本翻译

    API在线调试指南

    概述

    • 在应用开发过程中,由于业务特性需要服务器API协同使用,因此云信即时通信提供了账号管理、用户名片管理、好友管理、静音管理、黑名单管理、消息管理、会话功能、群组功能、聊天室功能、广播消息管理、系统通知管理API,企业可以使用这些API,根据实际需要开发应用。
    • 在应用开发对接过程中,该平台主要可以调用各种接口请求参数和返回数据的情况,供开发人员和测试人员测试 API 使用情况。

    API 调试

    调用前准备

    • 已在云信控制台创建应用,并已开通服务,获取App Key 和 App Secret。详情请参见创建应用和获取 App key 。
    • 应用服务端调用 API 向云信 IM 服务端发起的请求需遵循固定的请求结构和请求方式。具体内容参见API调用方式。

    调试方式

    ApiFox支持两种方式进行接口调试,具体参见以下内容:

    方式一:未登录Apifox平台进行调试(推荐)

    • 未登录ApiFox平台情况下,不能执行前置脚本,导致无法自动生成部分请求头信息(Checksum等),因此需要按如下方式进行参数设置。
    • 选择去设置环境变量,设置AppKey,Nonce, CurTime,CheckSum字段,CheckSum字段签算代码参见官方样例,由于安全原因CheckSum有5分钟有效期,调试过程中注意该参数有效周期,参加下图:

    image.png

    • 设置完成后直接点击发送,即可调试相关接口

    方式二:登录Apifox平台后进行调试

    • 点击Run in Apifox,既进入Apifox平台, 需要相关账号登录
    • 该方式调试需要为项目团队成员,因此可以点击左侧克隆项目,克隆一份项目到自己的名下

    📌

    Note:该方式不能保证两个工程内容持续一致,官方接口有所调整或变更不能及时同步,增加问题排查时间

    • 该方式可以执行前置脚本,按如下图配置AppKey, AppSecret,调用API时可以自动根据AppKey, AppSecret自动签算相关请求头内容。

    📌

    Note:
    1,由于是在第三方平台进行在线接口调试,信息会保存在三方平台,因此生产环境不建议使用该方式进行调试,相关数据Appkey,AppSecret为应用私密信息,请妥善保管该信息,减少私密信息暴露。
    2,应尽量选取方式一调试,或仅仅测试环境采用该方式进行调试

    image.png

    注意事项

    📌

    由于ApiFox平台限制,部分接口请求参数和请求模式与官网文档不一致,实际参数以官方文档为准,ApiFox只作为测试调试使用。
    样例: long类型需要配置为Integer

    下一页
    注册云信IM账号
    Built with