请求结构
更新时间: 2023/02/13 02:08:30
发起 API 请求的 URL 由不同参数拼接而成,有固定的请求结构。本产品服务端 API 请求结构主要由三部分组成:
-
URL:指向具体的业务请求,请参见各个 API 接口文档。
-
Header:包括云信 AppKey、CheckSum 等在内的鉴权信息。
-
Body:包括 API 对应的请求参数。若接口没有请求参数,则无需传递 Body。
每篇 API 文档均给出了请求示例供您参考,请在发起请求前自行编码。接口调用成功会显示返回参数,调用失败则显示相应报错,您可以根据错误码分析排查。
Header
Header 中包括用于鉴权的相关公共参数,用于标识用户和接口签名。如非必要,每个单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
参数名称 | 是否必选 | 描述 |
---|---|---|
clientType | 必选 | 用户的设备类型,包括 aos、ios、pc 和 web。 |
deviceId | 必选 | 唯一设备号。 |
user | 可选(鉴权含 USER_TOKEN 时必选) | 用户的 userUuid。 |
token | 可选(鉴权含 USER_TOKEN 时必选) | 用户的 userToken。 |
Authorization | 可选 | Basic base64(cert_id:cert)。 |
Body
服务端 API 请求的 Content-Type 为 application/json。传入的 Body 必须为 JSON 格式。
服务地址
网易云信互动直播组件 API 的服务接入地址为:http://roomkit.netease.im
。
通信协议
网易云信所有接口均支持通过 HTTPS 协议进行通信,保障更高的安全性。
字符编码
请求及返回结果均使用 UTF-8 字符集编码。
此文档是否对你有帮助?