PDF《云通信》

云通信 版权所有:腾讯云计算(北京)有限责任公司 第1 共348页 云通信 服务端集成 产品文档 云通信 版权所有:腾讯云计算(北京)有限责任公司 第2 共348页 【版权声明】 ?2013-2019 腾讯云版权所有 本文档著作权归腾讯云单独所有,未经腾讯云事先书面许可,任何主体不得以任何形式复制、修改、抄袭、传播全 部或部分本文档内容.

【商标声明】 及其它腾讯云服务相关的商标均为腾讯云计算(北京)有限责任公司及其关联公司所有.本文档涉及的第三方主体 的商标,依法由权利人所有. 【服务声明】 本文档意在向客户介绍腾讯云全部或部分产品、服务的当时的整体概况,部分产品、服务的内容可能有所调整.您 所购买的腾讯云产品、服务的种类、服务标准等应由您与腾讯云之间的商业合同约定,除非双方另有约定,否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第3 共348页 文档目录 服务端集成 生成 UserSig REST API REST API 简介 REST API 接口列表 帐号管理 单个帐号导入接口 批量帐号导入接口 帐号登录态失效接口 单聊消息 单发单聊消息 批量发单聊消息 导入单聊消息 在线状态 获取用户在线状态 资料管理 拉取资料 设置资料 关系链管理 添加好友 导入好友 更新好友 删除好友 删除所有好友 校验好友 拉取好友 拉取指定好友 添加黑名单 删除黑名单 拉取黑名单 校验黑名单 添加分组 删除分组 群组管理 获取 App 中的所有群组 云通信 版权所有:腾讯云计算(北京)有限责任公司 第4 共348页 创建群组 获取群组详细资料 获取群组成员详细资料 修改群组基础资料 增加群组成员 删除群组成员 修改群成员资料 解散群组 获取用户所加入的群组 查询用户在群组中的身份 批量禁言和取消禁言 获取群组被禁言用户列表 在群组中发送普通消息 在群组中发送系统通知 群组消息撤回 转让群组 导入群基础资料 导入群消息 导入群成员 设置成员未读消息计数 删除指定用户发送的消息 拉取群漫游消息 脏字管理 查询 App 自定义脏字 添加 App 自定义脏字 删除 App 自定义脏字 全局禁言管理 设置全局禁言 查询全局禁言 运营相关 拉取运营数据 下载消息记录 第三方回调 第三方回调简介 第三方回调配置 回调命令列表 在线状态相关回调 状态变更回调 云通信 版权所有:腾讯云计算(北京)有限责任公司 第5 共348页 资料关系链相关回调 添加好友之后回调 删除好友之后回调 添加黑名单之后回调 删除黑名单之后回调 单聊消息相关回调 发单聊消息之前回调 发单聊消息之后回调 群组系统相关回调 创建群组之前回调 创建群组之后回调 申请入群之前回调 拉人入群之前回调 新成员入群之后回调 群成员离开之后回调 群内发言之前回调 群内发言之后回调 群组满员之后回调 群组解散之后回调 群组资料修改之后回调 回调双向认证配置指南 Apache双向认证配置 Nginx双向认证配置 云通信 版权所有:腾讯云计算(北京)有限责任公司 第6 共348页 本文将指导您如何生成 UserSig. 下载签名用的私钥 1. 登录云通信 IM 控制台. 服务端集成 生成 UserSig 最近更新时间:2019-06-11 15:44:43 说明: 如果您还没有应用,请先 创建应用,然后执行 步骤2. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第7 共348页2. 单击目标应用所在行的【应用配置】,进入应用详情页面. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第8 共348页3. 单击帐号体系集成右侧的【编辑】,配置帐号管理员信息,单击【保存】. 4. 单击【下载公私钥】,保存 keys.zip 压缩文件. 5. 解压 keys.zip文件 ,获得 private_key.txt 和public_key.txt 文件,其中 private_key.txt 即为私钥文件. 控制台手动生成 UserSig 1. 登录云通信 控制台. 说明: 如果您还没有应用,请先 创建应用,然后执行 步骤2. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第9 共348页2. 单击目标应用所在行的【应用配置】,进入应用详情页面. 3. 选择【开发辅助工具】页签,填写【用户名(UserID)】,拷贝私钥文件内容至【私钥(PrivateKey)】文本框 中,单击【生成签名】,在【签名(UserSig)】文本框中即可获得该云通信应用指定用户名的 UserSig. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第10 共348页UserID 和UserSig 可以直接用在我们提供的 Demo 中,便于您快速测试和调试. 服务器生成 UserSig 生成原理 注意: 真正需要线上使用时,不能采用控制台手动生成 UserSig 方案,会有极大的安全隐患,建议使用下文介绍的 服务器生成 UserSig 方案. 云通信 版权所有:腾讯云计算(北京)有限责任公司 第11 共348页 将生成代码部署在您的服务器上,并提供面向 App 的服务端接口. 使用上文提到的 private_key 对SDKAppID、Identifier 和Expire(签名过期时间)进行非对称加密运算,并将 计算结果返回给 App. 如果出现 private_key 泄露的情况,请 提交工单 申请更换. UserSig = 非对称加密(private_key, SdkAppid, Identifier, Expire) 源码下载 我们提供了下列语言或平台的 UserSig 生成代码,您可以直接下载并集成到您的服务端. 语言版本 关键函数 下载链接 Java genSig Github GO genSig Github PHP genSig Github C# genSig Github Nodejs genSig Github C++ gen_sig Github Python gen_sig Github 云通信 版权所有:腾讯云计算(北京)有限责任公司 第12 共348页REST API 是云通信 IM 提供给 App 后台的 HTTP 管理接口,其主要目的在于为 App 后台提供一个后台管理入口. 目前云通信 IM 支持的 REST API 请参见 REST API 接口列表. 除了 REST API,App 控制台也可实现简单的数据管理、单发/群发消息,开发者可以在控制台进行简单的数据管 理、查看及测试.相比之下,REST API 接口较为原始,但管理能力却更为强大. 为了安全性,REST API 仅提供 HTTPS 接口. 前提条件 要调用 REST API,您必须已完成: 1. 在云通信 IM 控制台创建 App,具体方法参见 应用接入指引. 2. 为您的 App 指定管理员帐号,具体方法参见 基础配置 的帐号体系集成. 调用方法 请求 URL REST API 的URL 格式如下: https://console.tim.qq.com/$ver/$servicename/$command?sdkappid=$SDKAppID&