你可以在控制台上管理 AppID,也可以通过 OpenAPI 实现应用管理。你可以使用 CreateApp 这个 OpenAPI 实现这一功能。

接口行为

你可以使用 CreateApp 接口,创建 AppID。

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

在你使用该接口创建应用后,应用默认为启用状态。

前提条件

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

使用限制
请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是CreateApp接口名称
VersionString是2020-12-01OpenAPI 版本
Body
参数名类型必填示例值描述
AppNameString是myApp
  • 应用名称
  • 命名规则:字符串中只能包含中文字符、英文大小写字符、数字和下划线;长度不能超过24个字符。
  • 请求示例代码
    Query
    https://rtc.volcengineapi.com?Action=CreateApp&Version=2020-12-01
    
    postscript
    Body
    {
        "AppName": "Your_AppName"
    }
    
    json
    返回调用结果
    返回参数
    参数名类型描述
    AppIdString应用 ID
    AppKeyString主 AppKey,用于生成 Token
    SecondaryAppKeyString副 AppKey,启用后可用于生成 Token
    NameString应用名称
    OwnerString应用所属的账号 ID
    InstanceStatusInt
  • 服务状态。取值:
  • 0: 创建中——指 AppID 在初始化
  • 1: 运行中——指当前 AppID 为正常服务状态
  • 6: 欠费关停
  • 98: 已停用——指调用服务端停用接口,当前 AppID 被设置为不可用状态
  • CreateDateString创建时间
    InstanceIdString计费实例 ID
    正常返回示例

    创建的 app 信息在 Result 中显示。

    {
        "ResponseMetadata": {
            "RequestId": "2021081717484101022524310002120A9F",
            "Action": "CreateApp",
            "Version": "2020-12-01",
            "Service": "rtc",
            "Region": "cn-north-1"
        },
        "Result": {
            "AppId": "6000000000000000000000000",
            "AppKey": "a0000000000000000000000000000000",
            "SecondaryAppKey":"b0000000000000000000000000000000",
            "Name": "myApp",
            "Owner": "2000000000",
            "InstanceStatus": 1,
            "CreateDate": "2021-08-17T17:48:41.973243689+08:00",
            "InstanceId": "VeRTC0000000000000000000"
        }
    }
    
    json