CreateApp

Last updated: 2019-12-05 17:29:02

1. API Description

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

This API is used to create a GME application.

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

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 parameter. The value used for this API: CreateApp
Version Yes String Common parameter. The value used for this API: 2018-07-11
Region No String Common parameter. This parameter is not required for this API.
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 service regions. Valid values: mainland (Mainland China), sa (South America), eu (Europe), oc (Australia), 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 and speech-to-text
VoiceFilterConf No VoiceFilterConf Configuration information of phrase analysis
Tags.N No Array of Tag List of tags to be added

3. Output Parameters

Parameter Name Type Description
BizId Integer Application ID, which is automatically generated by the backend
AppName String Application name, which is passed through from the AppName input parameter
ProjectId Integer Project ID, which is passed through from the entered ProjectId
SecretKey String Application key, which is used when the GME SDK is initialized
CreateTime Integer Service creation timestamp
RealtimeSpeechConf RealtimeSpeechConf Configuration information of voice chat
VoiceMessageConf VoiceMessageConf Configuration information of voice messaging and speech-to-text
VoiceFilterConf VoiceFilterConf Configuration information of phrase analysis

4. Example

Example1 Creating a GME application by using default configuration

This example shows you how to create a GME application in the easiest way.

Input Example

https://gme.tencentcloudapi.com/?Action=CreateApplication
&AppName=simple_gme_application
&<Common request parameter>

Output Example

{
  "Response": {
    "Data": {
      "AppName": "simple_gme_application",
      "CreateTime": 1568945078,
      "ProjectId": 0,
      "BizId": 140000001,
      "SecretKey": "abcdefghijklmnop",
      "RealtimeSpeechConf": {
        "Status": "open",
        "quality": "ordinary"
      },
      "VoiceMessageConf": {
        "Status": "close",
        "language": "cnen"
      },
      "VoiceFilterConf": {
        "Status": "close"
      }
    },
    "RequestId": "e2900289-f21e-43a8-a3bf-0b439cdbbbb8"
  }
}

Example2 Creating a GME application by using custom configuration

This example shows you how to use project 10000, enable voice chat with high sound quality, disable voice messaging and speech-to-text, and enable phrase filtering.

Input Example

https://gme.tencentcloudapi.com/?Action=CreateApplication
&AppName=simple_gme_application
&ProjectId=10000,
&RealtimeSpeechConf.Status=open
&RealtimeSpecchConf.Quality=high
&VoiceMessageConf.Status=close
&VoiceFilterConf.Status=open
&<Common request parameter>

Output Example

{
  "Response": {
    "Data": {
      "AppName": "simple_gme_application",
      "CreateTime": 1568945078,
      "ProjectId": 10000,
      "BizId": 140000002,
      "SecretKey": "abcdefghijklmnop",
      "RealtimeSpeechConf": {
        "Status": "open",
        "Quality": "high"
      },
      "VoiceMessageConf": {
        "Status": "open",
        "Language": "cnen"
      },
      "VoiceFilterConf": {
        "Status": "open"
      }
    },
    "RequestId": "d61be8ca-f010-11e9-af81-fa163ee00eb7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Invalid parameter
InvalidParameter.TagKey Invalid tag.
UnauthorizedOperation Unauthorized operation
UnauthorizedOperation.CreateAppDenied Application creation is not authorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation