tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateApp

Last updated: 2023-07-06 14:47:54

1. API Description

Domain name for API request: gme.tencentcloudapi.com.

This API is used to create a GME application.

A maximum of 200 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateApp.
Version Yes String Common Params. The value used for this API: 2018-07-11.
Region No String Common Params. This parameter is not required.
AppName Yes String Application name
ProjectId No Integer Tencent Cloud project ID. Default value: 0, which means that the default project is used.
EngineList.N No Array of String List of engines to be supported.
Valid values: android, ios, unity, cocos, unreal, windows. All values are selected by default.
RegionList.N No Array of String List of regions.
Valid values: mainland (Chinese mainland), hmt (Hong Kong, Macao and Taiwan (China)), sea (Southeast Asia), na (North America), eu (Europe), jpkr (Japan, Korea and Asia Pacific), sa (South America), oc (Oceania), me (Middle East). All values are selected by default.
RealtimeSpeechConf No RealtimeSpeechConf Configuration information of Voice Chat
VoiceMessageConf No VoiceMessageConf Configuration information of Voice Messaging
VoiceFilterConf No VoiceFilterConf Configuration information of Voice Analysis Service
AsrConf No AsrConf Configuration information of Speech-to-Text
Tags.N No Array of Tag List of tags to be added

3. Output Parameters

Parameter Name Type Description
Data CreateAppResp Returned data
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a GME application by using custom configuration

This example shows you how to create a GME application 123, enable Voice Chat with high sound quality, enable Voice Messaging, and disable Phrase Filtering and ASR Speech-to-Text.

Input Example

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApp
<Common request parameters>

{
    "AppName": "123",
    "ProjectId": 0,
    "EngineList": [
        "android"
    ],
    "RegionList": [
        "mainland"
    ],
    "RealtimeSpeechConf": {
        "Status": "open",
        "Quality": "high"
    },
    "VoiceMessageConf": {
        "Status": "open",
        "Language": "all"
    },
    "VoiceFilterConf": {
        "Status": "close",
        "SceneInfos": [
            {},
            {},
            {}
        ]
    },
    "AsrConf": {
        "Status": "close"
    },
    "Tags": [
        {
            "TagKey": "abc",
            "TagValue": "abc"
        }
    ]
}

Output Example

{
    "Response": {
        "Data": {
            "AppName": "123",
            "AsrConf": {
                "Status": "close"
            },
            "BizId": 1410000000,
            "CreateTime": 1681894000,
            "ProjectId": 0,
            "RealtimeSpeechConf": {
                "Quality": "high",
                "Status": "open"
            },
            "SecretKey": "7f9xxac16axxx49x",
            "VoiceFilterConf": {
                "SceneInfos": [
                    {},
                    {},
                    {}
                ],
                "Status": "close"
            },
            "VoiceMessageConf": {
                "Language": "all",
                "Status": "open"
            }
        },
        "RequestId": "f28xxxfe-8xx8-4xx6-bcxx-22xxxfd00xxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.UserFeeNegative Operation not allowed as your account is in arrears.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.TagKey Incorrect tag.
LimitExceeded.Application The number of created applications has reached the upper limit.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.CreateAppDenied Application creation is not authorized.
UnauthorizedOperation.UnRealNameAuth Unverified user.
UnknownParameter Unknown parameter error.
UnsupportedOperation Operation unsupported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy