创建伴随程序 CreateFrameworkApp--云游戏-火山引擎

文档中心

立即注册

导航

创建伴随程序 CreateFrameworkApp

最近更新时间：2025.09.15 16:05:13首次发布时间：2022.07.28 15:09:50

在指定业务下，注册和创建伴随程序。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateFrameworkApp&Version=2022-02-10

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateFrameworkApp
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-02-10

Body 参数

字段	类型	必填	说明
framework_app_name	String	是	伴随程序名称
framework_app_start	Int8	否	伴随程序启动时机： 1（StartBefore：在游戏开始前启动） 2（StartAfter：在游戏开始后启动，默认)
framework_app_info	AppInformation	是	伴随程序基本信息，参考以下 AppInformation 结构说明

字段

类型

必填

说明

framework_app_name

String

是

伴随程序名称

framework_app_start

Int8

否

伴随程序启动时机：

1（StartBefore：在游戏开始前启动）
2（StartAfter：在游戏开始后启动，默认)

framework_app_info

AppInformation

是

伴随程序基本信息，参考以下 AppInformation 结构说明

AppInformation 结构说明

字段	类型	必填	说明
download_url	String	是	伴随程序安装包下载地址，支持 HTTP 和 HTTPS
package_name	String	是	伴随程序安装包名称，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动伴随程序可能失败）
version_code	Int32	是	伴随程序版本号，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动伴随程序可能失败）
md5	String	是	伴随程序安装文件 MD5，可通过调用 DetailParseTask 接口获取（需保证传入信息的准确性，否则启动伴随程序可能失败）
package_size	Int64	是	安装文件大小，单位 byte，可通过调用 DetailParseTask 接口获取（对应 file_size 字段）

返回结果

通用返回参数，参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：

字段	类型	说明
framework_app_id	String	如果伴随程序创建成功，返回创建的伴随程序 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateFrameworkApp
&Version=2022-02-10
&<通过header传入的公共请求参数>

{
    "framework_app_name": "伴随程序名",
    "framework_app_start": 1,
    "framework_app_info": {
        "download_url": "https://xxx-file.xxxxxx.com/cloudgame/xxxxxx.apk?x-expires=25862xxxxxx&x-signature=XXXXXX",
        "package_name": "com.image.frameworkappname",
        "version_code": 235,
        "md5": "5403bf7211ec9fb042a6825876xxxxxx",
        "package_size": 78460345
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateFrameworkApp",
        "Region": "cn-north-1",
        "RequestId": "20220216115400010225110011010B9483",
        "Service": "veGame",
        "Version": "2022-02-10"
    },
    "Result": {
        "framework_app_id": "7064470096059xxxxxx"
    }
}