You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 OpenAPI 参考/应用管理/创建应用 CreateApp
创建应用 CreateApp
最近更新时间：2024.10.14 17:25:23首次发布时间：2023.12.27 19:58:10
我的收藏

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频服务中，你可以通过调用此接口实现应用的创建。

通过指定应用名称，你能够创建一个全新的应用实例，该实例在创建后默认处于启用状态。调用此接口后，接口会返回应用 ID、主副 AppKey、应用名称、账号 ID、服务状态、创建时间以及计费实例 ID 等详细信息。

使用此接口创建 AppID 的效果和在控制台上手动创建一致。关于手动获取 AppID，参看：获取 AppID。

使用说明

前置条件

你必须已在控制台上开通了 RTC 服务，完成实名认证，并确定了计费类型。

注意事项

  • 请求频率：QPS 不超过 20。
  • AppID 数量：单个账号最多可以创建 100 个 AppID。
  • 该接口请求接入地址仅支持 rtc.volcengineapi.com。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=CreateApp&Version=2023-11-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数
类型
是否必选
示例值
描述
Action
String
是
CreateApp
接口名称。当前 API 的名称为 CreateApp。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。

Body

参数
类型
是否必选
示例值
描述
AppName
String
是
myApp
  • 应用名称
  • 命名规则：字符串中只能包含中文字符、英文大小写字符、数字和下划线；长度不能超过24个字符。

返回参数

下表仅列出本接口特有的返回参数。公共返回参数请参见返回结构。

参数
类型
示例值
描述
AppId
String
661e****543cf
应用 ID
AppKey
String
AKLTMzV****NDcyNgs
主 AppKey，用于生成 Token
SecondaryAppKey
String
AKLTMzV****NDcyNda
副 AppKey，启用后可用于生成 Token
Name
String
myApp
应用名称
Owner
String
210****260
应用所属的账号 ID
InstanceStatus
Integer
1
  • 服务状态。取值及含义如下：
  • 0: 创建中——指 AppID 在初始化
  • 1: 运行中——指当前 AppID 为正常服务状态
  • 6: 欠费关停
  • 98: 已停用——指调用服务端停用接口，当前 AppID 被设置为不可用状态
CreateDate
String
2021-08-17T17:48:41.973243689+08:00
创建时间
InstanceId
String
InstanceId0001
实例 ID

请求示例

POST https://rtc.volcengineapi.com?Action=CreateApp&Version=2023-11-01
{
    "AppName": "testapp"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "CreateApp",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "AppId": "661e****543cf",
        "AppKey": "AKLTMzV****NDcyNda",
        "SecondaryAppKey": "AKLTMzV****NDcyNjU",
        "Name": "myApp",
        "Owner": "210****260",
        "InstanceStatus": 1,
        "CreateDate": "2021-08-17T17:48:41.973243689+08:00",
        "InstanceId": "InstanceId1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。