外观
概述
约 286 字小于 1 分钟
2025-04-14
即时通信IM还提供了部分服务端API,用于开发者进行应用开发。
请求地址
对于服务端的API请求,请使用以下地址,在后续服务端API中使用变量 $host 代替:
https://chat.xiangbaicheng.com请求参数
- 对于
GET请求,请求参数应以QueryString的形式写在 URL 中。 - 对于
POST请求,请求参数应以JSON的形式放在请求体中,如有特殊情况,会在具体接口文档中说明。 - 不管是哪种请求,除开
获取授权码接口之外,其他接口请求头都需要携带X-Token,其值应为授权码。
响应格式
所有接口的响应格式均为 JSON,且包含以下字段:
code:响应状态码,0表示成功,其他值表示失败,具体参考错误码。msg:响应信息,用于描述响应状态。data:响应数据,具体内容由接口文档说明。
注意
在服务端API文档中,返回结果均指的是上述data字段中的内容,而不是整个响应体。