开发文档阅读说明

聚合聊天API开放了丰富的能力接口，开发者可以借助接口能力，实现企业服务及聚合聊天系统的集成。支持的能力，通过目录导航可以快速预览，目录树按功能块聚合归类，如通获取好友、消息推送等。

文档的阅读次序，建议先阅读一遍开发指南，以及接口access_token获取。然后就可以独立查看各个功能块文档说明。

所有的接口需使用HTTP协议、JSON数据格式、UTF8编码。接口说明格式如下：

请求方式：GET/POST（HTTPS）
请求地址：http://《你服务器IP》/5001/publicapi/v1/GetAccessToken
请求包体：
...
参数说明：
...
权限说明：
...
返回结果：
...
参数说明：
...

独立部署

请求URL：http://《当前服务器的IP》:5001/publicapi/v1（v1是大版本指引）

公共服务器

请求URL：http://api10.agsoft.net:5001/publicapi/v1（v1是大版本指引）

请求方式，标明接口调用的HTTP方法，区分HttpGet/HttpPost请求。所有的请求都为http(根据服务器本身情况)协议。

请求每次都必须带上Headers内容标式（具体参考Headers 构建）

请求包体/参数说明，标明请求参数示例及说明，参数说明包括字段含义、取值范围，开发者在设计数据结构时，应参考该定义范围。

返回结果/参数说明，标明返回参数示例及说明。特别留意，所有接口在调用失败时返回包里都有errmsg、succeed（部分接口在调用成功时没有返回errmsg和succeed）。开发者需根据succeed是否为FALSE，否则为成功（errmsg意义请见全局错误码）。而errmsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据。

接口调用流程

获取access_token，参考文档说明。

缓存和刷新access_token。

开发者需要缓存access_token，用于后续接口的调用。当access_token失效或过期时，需要重新获取。

调用具体的业务接口

使用工具调试api

我们已经创建好一个自建应用，且拿到了可用的应用id及secret，如何调用api控制这个应用呢？下面以发消息为例说明如何调试api接口。

调用api的过程，本质上就是发送http请求给聚合聊天公共接口，在正式开发前，我们可以使用工具模拟http请求调试api。这里以 postman 为例（下载地址，使用方法略），当然你也可以使用其它http模拟工具。

独立部署#

公共服务器#

接口调用流程#

使用工具调试api#

独立部署

公共服务器

接口调用流程

使用工具调试api