API概述
更新时间：2025-05-30 14:20:53
调用RTCX平台API时，您需要了解API的公共信息，包括网关协议与地址、调用方法、请求参数、返回参数等信息。
API网关协议与地址
当您发送请求调用API时，API网关会校验含有AppSecret的签名。其中，API网关的协议为HTTPS，网关地址如下。
| 数据中心 | regionId | 网关地址 |
|---|---|---|
| 中国大陆 | 0 | third-gateway.iotrtc.cn |
| 美国 | 3 | third-gateway.iotrtcus.com |
公共请求参数
API都遵循一致的入参规范，其中如下字段为接口调用必须传入的公共字段。
云端API公共请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 是 | 请求ID，该参数主要用于关联请求应答及问题定位 |
| version | String | 是 | 版本号，当前固定为1.0.0 |
| request | Object | 是 | 系统请求参数。 |
| apiVer | String | 是 | 所调用接口对应的版本号，具体参见相应的接口文档。 |
| cloudToken | String | 是 | 自行获取对应的Token， 获取云端资源token和刷新云端资源token无需传递此参数，其他接口除特殊说明外默认均需传递此参数， 具体API请参见云端资源服务的获取云端资源token。 |
| params | Object | 是 | 业务请求参数，具体内容因不同的接口而不同。如不存在参数填{} |
公共返回参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 是 | 用于识别请求记录 |
| code | Int | 是 | 接口返回码字段，请求成功时返回200；请求失败时返回详细的错误码 |
| message | String | 否 | 接口返回信息字段，请求成功返回success；请求失败返回错误原因。 |
| data | Object | 否 | 接口返回值字段，每个接口的返回值皆可自定义（部分接口没有返回值，仅通过返回码标识请求成功或失败）。 |