API 接口列表
本文档列出了即时通讯(IM)服务端提供的 API 接口、调试工具、及注意事项。
提示
- IM Server API 当前为 v1 版本,全部接口均使用 POST 请求方式。
- 如果您首次接入 IM Server API,强烈推荐先了解 API 调用方法。
API 默认行为与配置
集成 IM Server API 需要注意以下默认行为:
- 应用服务端可调用 IM Server API 直接发送消息。如果以用户身份向群组、聊天室发送消息,不要求已加入群组或聊天室。
- 应用服务端调用 IM Server API 的行为不会在北极星的连接信息中生成记录。但通过 Server API 发送的消息均可通过北极星的消息流转查询。
- 如果应用配置了敏感词过滤、消息回调服务、第三方审核,请注意调用 Server API 发送的消息默认不进行过滤。如有需要,您需要在控制台免费基础功能页面启用 Server API 发送消息过滤敏感词。
- 如果应用启用了全量消息路由,请注意调用 Server API 发送的消息默认不进行路由。如有需要,您需要在控制台免费基础功能页面启用 Server API 发送消息实时路由。
- Server API 的部分接口为即时通讯的高级、扩展特 性或付费增值提供的接口。需要为开通服务后才能使用。您可以在控制台的免费基础功能页面与 IM 服务管理页面找到大部分服务配置开关,也可以在阅读相关 API 接口文档时找到具体细节。
API 调试工具
提示
本文档已列出了 API 接口在控制台「北极星」调试地址(需登录开发者账号)。
- 控制台「北极星」开发者工具箱的 IM Server API 调试 页面提供了大部分 API 接口的调试功能。请注意区分开发环境与生产环境。