文档中心

实时音视频

请输入

调用方法

如何调用 OpenAPI

在应用中集成 RTC 客户端 SDK 实现音视频通信后，也可以通过服务端 OpenAPI 对通话进行控制（例如踢人、云端处理、数据监控等）。

准备工作

获取 API 密钥（AK、SK）。具体操作，请参见 API 访问密钥管理。

主账号拥有资源的所有权限，其 AccessKey 一旦泄露风险巨大，所以建议您使用满足最小化权限需求的 IAM 用户的 AccessKey。具体操作，可参见创建 IAM 用户并授权。

快速测试

调试：通过 API Explorer 在线调用和调试 RTC OpenAPI，它可以快速验证请求参数、获取响应结果。

获取可运行的 curl 命令：使用 API Explorer 的签名自动生成功能，只需输入 AK/SK、服务地址、必填参数等信息，就会自动生成可执行的 curl 命令，适合快速测试和调试接口。

在生产环境中集成

方式 1：通过 SDK 集成

如果您的编程语言为 Golang、Python、Java、PHP、Node.js，官方提供了已封装签名算法的示例，供直接调用。

开发语言	签名 SDK
Golang SDK	volc-sdk-golang
Java SDK	volc-sdk-java
Python SDK	volc-sdk-python
Nodejs SDK	volc-sdk-nodejs
PHP SDK	volc-sdk-php

方式 2：手动构造请求

如果您使用的编程语言没有官网 SDK，可基于标准 HTTP 协议手动构造 HTTP 请求，并自行实现签名算法。

完整请求结构

一个有效的 OpenAPI 请求必须包含：请求行 + 请求头（含签名）+ 请求体。完整结构如下：

# -------------------- Part 1: 请求行 --------------------​
[Method] https://[Host]/?Action=[Action]&Version=[Version]​
​
# -------------------- Part 2: 请求头 --------------------​
Host: [参考下方说明]   ​
Content-Type: [参考下方说明] ​
X-Date: [动态生成的当前 UTC 时间]​
X-Content-Sha256: [根据 Part 3 请求体计算出的 SHA256 哈希值]​
Authorization: [必须生成签名，用于鉴权]​
​
# -------------------- Part 3: 请求体 --------------------​
# 对于 POST 请求，这里是“接口特有参数”​
{​
    "Parameter1": "Value1",​
    "Parameter2": "Value2",​
    ...​
}​

请求行

[Method] https://[Host]/?Action=[Action]&Version=[Version]

[Method]、[Action]、[Version]：可在对应接口文档获取。以 StartRecord 接口为例，如下图所示：

[Host]：服务接入地址，请参见服务地址。

请求头（需携带鉴权签名）

参数	如何获取 / 构造
[Host]	服务接入地址，与请求行中的 Host 保持一致。
[Content-Type]	资源的 MIME 类型。对于 POST 请求，固定为 application/json；Get 请求中，该值可为空。
[X-Date]	请求时间， UTC 格式（ISO 8601），精确到秒，例如 20201230T081805Z。
[X-Content-Sha256]	请求体的 SHA256 哈希值。若请求体为空，则使用一个固定的哈希值。
[Authorization]	签名鉴权。此值必须通过算法计算，用于验证您的身份和请求内容的完整性。具体方法请参见签名方法。

请求体

JSON 格式，包含接口所需的业务参数。详细结构和字段说明，请参见对应的 API 文档。

最近更新时间：2026.09.28 10:46:15

这个页面对您有帮助吗？

有用

无用