接口请求域名: gme.intl.tencentcloudapi.com 。
本接口(CreateApp)用于创建一个GME应用。
默认接口请求频率限制:200次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateApp。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppName | 是 | String | 应用名称 |
| ProjectId | 否 | Integer | 腾讯云项目ID,默认为0,表示默认项目 |
| EngineList.N | 否 | Array of String | 需要支持的引擎列表,默认全选。 取值:android/ios/unity/cocos/unreal/windows |
| RegionList.N | 否 | Array of String | 服务区域列表,默认全选。 取值:mainland-大陆地区,hmt-港澳台,sea-东南亚,na-北美,eu-欧洲,jpkr-日韩亚太,sa-南美,oc-澳洲,me-中东 |
| RealtimeSpeechConf | 否 | RealtimeSpeechConf | 实时语音服务配置数据 |
| VoiceMessageConf | 否 | VoiceMessageConf | 语音消息服务配置数据 |
| VoiceFilterConf | 否 | VoiceFilterConf | 语音分析服务配置数据 |
| AsrConf | 否 | AsrConf | 语音转文本配置数据 |
| Tags.N | 否 | Array of Tag | 需要添加的标签列表 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CreateAppResp | 创建应用返回数据 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
创建GME应用123,开启实时语音服务,使用高音质;开启离线语音服务; 关闭语音过滤服务;关闭ASR语音转文本服务。
POST / HTTP/1.1
Host: gme.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApp
<公共请求参数>
{
"AppName": "simple_gme_application",
"ProjectId": 0,
"EngineList": [
"android"
],
"RegionList": [
"mainland"
],
"RealtimeSpeechConf": {
"Status": "open",
"Quality": "high"
},
"VoiceMessageConf": {
"Status": "open",
"Language": "all"
},
"VoiceFilterConf": {
"Status": "close",
"SceneInfos": [
{
"CallbackUrl": "http://xxx.xxxrealtimexxx.com",
"SceneId": "RealTime",
"Status": false
},
{
"CallbackUrl": "http://xxx.xxxvoicemessagexxx.com",
"SceneId": "VoiceMessage",
"Status": false
},
{
"CallbackUrl": "http://xxx.xxxgmeapixxx.com",
"SceneId": "GMECloudApi",
"Status": false
}
]
},
"AsrConf": {
"Status": "close"
},
"Tags": [
{
"TagKey": "tag_key_1",
"TagValue": "tag_value"
}
]
}
{
"Response": {
"Data": {
"AppName": "simple_gme_application",
"AsrConf": {
"Status": "close"
},
"BizId": 1410000000,
"CreateTime": 1681894000,
"ProjectId": 0,
"RealtimeSpeechConf": {
"Quality": "high",
"Status": "open"
},
"SecretKey": "7f9xxac16axxx49x",
"VoiceFilterConf": {
"SceneInfos": [
{
"CallbackUrl": "http://xxx.xxxrealtimexxx.com",
"SceneId": "RealTime",
"Status": false
},
{
"CallbackUrl": "http://xxx.xxxvoicemessagexxx.com",
"SceneId": "VoiceMessage",
"Status": false
},
{
"CallbackUrl": "http://xxx.xxxgmeapixxx.com",
"SceneId": "GMECloudApi",
"Status": false
}
],
"Status": "close"
},
"VoiceMessageConf": {
"Language": "all",
"Status": "open"
}
},
"RequestId": "f28xxxfe-8xx8-4xx6-bcxx-22xxxfd00xxx"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.UserFeeNegative | 欠费不可操作。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.TagKey | 标签不正确 |
| LimitExceeded.Application | 创建应用数已达上限。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.CreateAppDenied | 创建应用不被授权。 |
| UnauthorizedOperation.UnRealNameAuth | 该用户未进行实名认证。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈