- Release Notes
- Product Introduction
- SDK Download Guide
- Purchase Guide
- User Tutorial
- Getting Started
- Free Demo
- Client API
- Server APIs
- Error Codes
- Advanced Features
- FAQ
- Protocols
- GME Policy
- Glossary
- Release Notes
- Product Introduction
- SDK Download Guide
- Purchase Guide
- User Tutorial
- Getting Started
- Free Demo
- Client API
- Server APIs
- Error Codes
- Advanced Features
- FAQ
- Protocols
- GME Policy
- Glossary
AppStatisticsItem
Application usage statistics
Used by actions: DescribeAppStatistics.
| Name | Type | Description |
|---|---|---|
| RealtimeSpeechStatisticsItem | RealTimeSpeechStatisticsItem | Voice chat statistics Note: This field may return null, indicating that no valid values can be obtained. |
| VoiceMessageStatisticsItem | VoiceMessageStatisticsItem | Voice messaging statistics Note: This field may return null, indicating that no valid values can be obtained. |
| VoiceFilterStatisticsItem | VoiceFilterStatisticsItem | Phrase filtering statistics Note: This field may return null, indicating that no valid values can be obtained. |
| Date | Date | Statistical period |
ApplicationDataStatistics
Application statistics
Used by actions: DescribeApplicationData.
| Name | Type | Description |
|---|---|---|
| BizId | Integer | Application ID |
| DauDataNum | Integer | DAU data |
| DauDataMainland | Array of StatisticsItem | DAU in Chinese mainland |
| DauDataOversea | Array of StatisticsItem | DAU outside Chinese mainland |
| DauDataSum | Array of StatisticsItem | Total DAU |
| DurationDataNum | Integer | Number of voice chat metrics |
| DurationDataMainland | Array of StatisticsItem | Duration of voice chat in Chinese mainland in minutes |
| DurationDataOversea | Array of StatisticsItem | Duration of voice chat outside Chinese mainland in minutes |
| DurationDataSum | Array of StatisticsItem | Total duration of voice chat in minutes |
| PcuDataNum | Integer | PCU data |
| PcuDataMainland | Array of StatisticsItem | PCU in Chinese mainland |
| PcuDataOversea | Array of StatisticsItem | PCU outside Chinese mainland |
| PcuDataSum | Array of StatisticsItem | Total PCU |
CreateAppResp
Output parameters of CreateApp
Used by actions: CreateApp.
| Name | Type | Description |
|---|---|---|
| BizId | Integer | App ID, automatically generated by the backend. |
| AppName | String | App name, the input of AppName. |
| ProjectId | Integer | Project ID, the input of ProjectId. |
| SecretKey | String | App key, used to initialize GME SDK. |
| CreateTime | Integer | Timestamp, indicating when the service is created. |
| 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 |
DescribeAppStatisticsResp
Output parameters of app usage statistics
Used by actions: DescribeAppStatistics.
| Name | Type | Description |
|---|---|---|
| AppStatistics | Array of AppStatisticsItem | App usage statistics |
DescribeScanResult
Returned speech detection result
Used by actions: DescribeScanResultList.
| Name | Type | Description |
|---|---|---|
| Code | Integer | Business return code |
| DataId | String | Unique data ID |
| ScanFinishTime | Integer | Detection completion timestamp |
| HitFlag | Boolean | Whether non-compliant information is detected |
| Live | Boolean | Whether it is a stream |
| Msg | String | Business return description Note: this field may return null, indicating that no valid values can be obtained. |
| ScanPiece | Array of ScanPiece | Detection result, which will be returned if Code is 0Note: this field may return null, indicating that no valid values can be obtained. |
| ScanStartTime | Integer | Detection task submission timestamp |
| Scenes | Array of String | Speech detection scenario, which corresponds to the Scene at the time of request |
| TaskId | String | Speech detection task ID, which is assigned by the backend |
| Url | String | File or stream address |
| Status | String | Detection task execution result task. Valid values: |
| BizId | Integer | ID of the application submitted for detection |
ModifyAppStatusResp
Output parameters of ModifyAppStatus
Used by actions: ModifyAppStatus.
| Name | Type | Description |
|---|---|---|
| BizId | Integer | GME app ID |
| Status | String | App status. Valid values: open, close |
RealTimeSpeechStatisticsItem
Voice chat usage statistics
Used by actions: DescribeAppStatistics.
| Name | Type | Description |
|---|---|---|
| MainLandDau | Integer | DAU in Mainland China |
| MainLandPcu | Integer | PCU in Mainland China |
| MainLandDuration | Integer | Total duration of use in Mainland China in minutes |
| OverseaDau | Integer | DAU outside Mainland China |
| OverseaPcu | Integer | PCU outside Mainland China |
| OverseaDuration | Integer | Total duration of use outside Mainland China in minutes |
RealtimeSpeechConf
Configuration information of voice chat
Used by actions: CreateApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | String | No | Voice chat status. Valid values: open, close |
| Quality | String | No | Voice chat sound quality. Valid value: high |
ScanDetail
Speech detection details
Used by actions: DescribeScanResultList.
| Name | Type | Description |
|---|---|---|
| Label | String | Violation scenario. For more information, please see the definition of Label |
| Rate | String | Confidence score in scenario. Value range: [0.00,100.00]. The higher the score, the more likely the content is non-compliant |
| KeyWord | String | Non-compliant keyword |
| StartTime | Integer | Start time offset in milliseconds from 0 of keyword in audio |
| EndTime | Integer | End time offset in milliseconds from 0 of keyword in audio |
ScanPiece
Speech detection result, which will be returned if Code is 0
Used by actions: DescribeScanResultList.
| Name | Type | Description |
|---|---|---|
| DumpUrl | String | Audio retention address, which will be returned for stream detection. The audio will be retained for 30 minutes Note: this field may return null, indicating that no valid values can be obtained. |
| HitFlag | Boolean | Whether non-compliant information is detected |
| MainType | String | Main non-compliant content type Note: this field may return null, indicating that no valid values can be obtained. |
| ScanDetail | Array of ScanDetail | Speech detection details |
| RoomId | String | GME voice chat room ID, which is the RoomId passed through when the task was submittedNote: this field may return null, indicating that no valid values can be obtained. |
| OpenId | String | GME voice chat user ID, which is the OpenId passed through when the task was submittedNote: this field may return null, indicating that no valid values can be obtained. |
| Info | String | Remarks Note: this field may return null, indicating that no valid values can be obtained. |
| Offset | Integer | Offset time in milliseconds of segment in stream during stream detection Note: this field may return null, indicating that no valid values can be obtained. |
| Duration | Integer | Segment duration during stream detection Note: this field may return null, indicating that no valid values can be obtained. |
| PieceStartTime | Integer | Segment detection start time Note: this field may return null, indicating that no valid values can be obtained. |
ScanVoiceResult
Returned result of speech detection
Used by actions: ScanVoice.
| Name | Type | Description |
|---|---|---|
| DataId | String | Data ID |
| TaskId | String | Task ID |
StatisticsItem
Usage data
Used by actions: DescribeApplicationData.
| Name | Type | Description |
|---|---|---|
| StatDate | Date | Date in the format of yyyy-mm-dd, such as 2018-07-13 |
| Data | Integer | Statistics |
Tag
Tag list
Used by actions: CreateApp.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Tag key Note: This field may return null, indicating that no valid values can be obtained. |
| TagValue | String | No | Tag value Note: This field may return null, indicating that no valid values can be obtained. |
Task
Speech detection task list
Used by actions: ScanVoice.
| Name | Type | Required | Description |
|---|---|---|---|
| DataId | String | Yes | Unique data ID |
| Url | String | Yes | URL-encoded data file URL, which is a pull address if the detected speech is a stream |
| RoomId | String | No | GME voice chat room ID, which is entered during speech detection by GME voice chat |
| OpenId | String | No | GME voice chat user ID, which is entered during speech detection by GME voice chat |
VoiceFilterConf
Configuration information of phrase filtering
Used by actions: CreateApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | String | No | Phrase filtering status. Valid values: open, close |
VoiceFilterStatisticsItem
Phrase filtering usage statistics
Used by actions: DescribeAppStatistics.
| Name | Type | Description |
|---|---|---|
| Duration | Integer | Total duration of phrase filtering |
VoiceMessageConf
Configuration information of voice messaging and speech-to-text
Used by actions: CreateApp.
| Name | Type | Required | Description |
|---|---|---|---|
| Status | String | No | Voice messaging and speech-to-text status. Valid values: open, close |
| Language | String | No | Language supported for voice messaging and speech-to-text. Valid values: all (all languages), cnen (Chinese and English). Default value: cnen |
VoiceMessageStatisticsItem
Voice messaging usage statistics
Used by actions: DescribeAppStatistics.
| Name | Type | Description |
|---|---|---|
| Dau | Integer | DAU of voice messaging and speech-to-text |
Yes
No
Was this page helpful?