V1 到 V2 迁移指南
Migrate from Vivox server-side recording version 1 to version 2.
阅读时间3 分钟最后更新于 3 天前
如果要对服务器端录制 API 版本 1 进行升级，请遵循本指南。
重要更改
V2 API 进行了以下更改：- TTL 不再是有效选项，必须对所有请求均使用历史记录。
- 该 API 现在支持使用 GCP 存储桶进行存储。
- 该 API 已重新设计，更加符合 REST 风格：
- 状态完整文件现已被回调服务器取代。
- SSR 现在需要使用来自 Unity Cloud 组织的服务帐户。
- 重复数据删除功能已被移除。您将不再看到关于重复请求的 错误代码。
409 - 自动结束功能已被移除。请求将始终在历史记录请求的整个持续时间内运行。
- 您无需再发出解码音频的请求。Vivox 将为您管理相关状态，最终结果将是频道中每个扬声器对应有一个 .WAV 文件。
Authentication 更改
-
SSR 现在要求所有请求都要使用 Unity Authentication。
- 如果尚未创建组织或项目，请创建一个。请参阅 如何创建项目 以了解更多信息。
- 拥有项目和组织后，需要将详细信息分享给您的客户经理。您的客户经理将为您的组织启用 SSR。
- 启用 SSR 后，您需要创建一个服务帐户以进行 API 身份验证。请参阅如何创建服务帐户。
-
在服务帐户页面上，为服务帐户分配权限。选择 Manage organization permissions 并分配 。这样，该服务帐户便能访问 SSR API。
Server Side Recording Processor Role
启用 SSR 权限的示例，从下拉选单中进行选择。
- 要使用此服务帐户，请参阅如何使用服务帐户进行身份验证。
API 更改
注意
SSR v2 的完整 API 文档可在 Web Services API 文档站点中找到。本指南仅涵盖从 V1 API 到 V2 API 的更改，不介绍任何新增功能。请参阅完整的 API 文档以了解新字段和选项的概述。
请求更改
V2 API 移除了用于传递请求字段的查询参数。现在，所有字段均以 JSON 形式传递到请求正文中。下面列出了不再存在的字段。-
现在包含在
destination_credentials中。要按照与 V1 API 相同的方式使用 AWS，必须替换特定的代码段。storageOptions替换此代码
替换为此代码
{
"destination_credentials": {
"bucket": "my-bucket",
"access_key_id": "secret",
"secret_access_key": "secret"
}
}{
"storageOptions": {
"provider": "aws",
"credentials": {
"bucket": "my-bucket",
"accessKeyId": "secret",
"secretAccessKey": "secret"
}
}
} -
移除 字段。V2 API 仅支持频道订阅。
target_type -
字段已被移除。现在使用
ttl字段指定录音的持续时间。history
注意
添加了一个可选字段 。此字段可以指定一个回调服务器，以便将作业状态接收到您托管的服务器上。您可以在此字段中指定任何 URL，Vivox 会向其发出请求。如需了解更多信息，请参阅回调服务器文档。
callbackUriSSR 解码器
SSR 解码器不再是单独的请求。请求的最终结果将是频道中每个扬声器对应有一个 .WAV 文件，并且您可以从基础结构中移除作业状态跟踪功能。回调服务器
删除status_completestatus_decoded