tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

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

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 Message 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 Reference period
AudioTextStatisticsItem AudioTextStatisticsItem Recording-to-Text usage statistics
Note: This field may return null, indicating that no valid values can be obtained.
StreamTextStatisticsItem StreamTextStatisticsItem Stream-to-Text usage statistics
Note: This field may return null, indicating that no valid values can be obtained.
OverseaTextStatisticsItem OverseaTextStatisticsItem Usage statistics of Voice-to-Text of outside-MLC requests
Note: This field may return null, indicating that no valid values can be obtained.
RealtimeTextStatisticsItem RealtimeTextStatisticsItem Real-time Voice-to-Text usage statistics
Note: This field may return null, indicating that no valid values can be obtained.

ApplicationDataStatistics

Application statistics

Used by actions: DescribeApplicationData.

Name Type Description
BizId Integer Application ID
DauDataNum Integer Number of DAU metrics
DauDataMainland Array of StatisticsItem DAUs in the Chinese mainland
DauDataOversea Array of StatisticsItem DAUs outside the Chinese mainland
DauDataSum Array of StatisticsItem Total DAUs
DurationDataNum Integer Number of Voice Chat metrics
DurationDataMainland Array of StatisticsItem Duration of Voice Chat in the Chinese mainland (in minutes)
DurationDataOversea Array of StatisticsItem Duration of Voice Chat outside the Chinese mainland (in minutes)
DurationDataSum Array of StatisticsItem Total duration of Voice Chat (in minutes)
PcuDataNum Integer Number of PCU metrics
PcuDataMainland Array of StatisticsItem PCUs in the Chinese mainland
PcuDataOversea Array of StatisticsItem PCUs outside the Chinese mainland
PcuDataSum Array of StatisticsItem Total PCUs

AsrConf

Configuration information of Speech-to-Text

Used by actions: CreateApp.

Name Type Required Description
Status String No Speech-to-Text status. Valid values: open, close.

AudioTextStatisticsItem

Recording-to-Text usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
Data Float Statistical value (in seconds)
Note: This field may return null, indicating that no valid values can be obtained.

CreateAppResp

Output parameters of CreateApp

Used by actions: CreateApp.

Name Type Description
BizId Integer Application ID, automatically generated by the backend.
AppName String Application name, the input of AppName.
ProjectId Integer Project ID, the input of ProjectId.
SecretKey String Application 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
VoiceFilterConf VoiceFilterConf Configuration information of Voice Analysis Service
AsrConf AsrConf Configuration information of Speech-to-Text

DeleteResult

Result of the operation to delete a room or remove members

Used by actions: DeleteRoomMember.

Name Type Description
Code Integer Status code. 0: Succeeded. Others: Failed\
ErrorMsg String Description

DescribeAppStatisticsResp

Output parameters of application usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
AppStatistics Array of AppStatisticsItem Application usage statistics

ModifyAppStatusResp

Output parameters of ModifyAppStatus

Used by actions: ModifyAppStatus.

Name Type Description
BizId Integer GME application ID
Status String Application status. Valid values: open, close.

OverseaTextStatisticsItem

Usage statistics of Voice-to-Text of outside-MLC requests

Used by actions: DescribeAppStatistics.

Name Type Description
Data Float Statistical value (in seconds)
Note: This field may return null, indicating that no valid values can be obtained.

RealTimeSpeechStatisticsItem

Voice Chat usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
MainLandDau Integer DAUs in the Chinese mainland
MainLandPcu Integer PCUs in the Chinese mainland
MainLandDuration Integer Total duration of use in the Chinese mainland (in minutes)
OverseaDau Integer DAUs outside the Chinese mainland
OverseaPcu Integer PCUs outside the Chinese mainland
OverseaDuration Integer Total duration of use outside the Chinese mainland (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 type. Valid values: high (HD), ordinary (SD).

RealtimeTextStatisticsItem

Real-time Voice-to-Text usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
Data Float Statistical value (in seconds)
Note: This field may return null, indicating that no valid values can be obtained.

RecordInfo

Information about the recording task in a room.
Note: This field may return null, indicating that no valid values can be obtained.

Used by actions: DescribeRecordInfo.

Name Type Description
UserId String User ID. The value is 0 in mixed streams recording mode.
FileName String Recording filename.
RecordBeginTime Integer Recording start time, which is a Unix timestamp. Example: 1234567868.
RecordStatus Integer Recording status. Valid values: 2: recording; 10: to be transcoded; 11: transcoding; 12: uploading; 13: uploaded; 14: user notified.

SceneInfo

Scenario information. Valid values:
RealTime: Voice Chat analysis;
VoiceMessage: Voice Messaging;
GMECloudApi: GME cloud APIs

Used by actions: CreateApp.

Name Type Required Description

StatisticsItem

Usage data unit

Used by actions: DescribeApplicationData.

Name Type Description
StatDate Date Date in the format of yyyy-mm-dd, such as 2018-07-13
Data Integer Statistical value

StreamTextStatisticsItem

Stream-to-Text usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
Data Float Usage of the service (in seconds)
Note: This field may return null, indicating that no valid values can be obtained.

SubscribeRecordUserIds

Allowlist or blocklist for stream subscription.

Used by actions: DescribeTaskInfo, ModifyRecordInfo, StartRecord.

Name Type Required Description
UnSubscribeUserIds Array of String No Blocklist for audio subscription. For example, ["1", "2", "3"] means to not subscribe to the audio streams of users 1, 2, and 3. If this parameter is left empty, the audio streams of all users (max 20) in the room will not be subscribed to.
Note: You cannot specify UnSubscribeAudioUserIds and SubscribeAudioUserIds at the same time.
SubscribeUserIds Array of String No Allowlist for audio subscription. For example, ["1", "2", "3"] means to subscribe to the audio streams of users 1, 2, and 3. If this parameter is left empty, the audio streams of all users (max 20) in the room will be subscribed to.
Note: You cannot specify UnSubscribeAudioUserIds and SubscribeAudioUserIds at the same time.

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.

VoiceFilterConf

Configuration information of Phrase Filtering

Used by actions: CreateApp.

Name Type Required Description
Status String No Phrase Filtering status. Valid values: open, close.
SceneInfos Array of SceneInfo No Scenario configuration information, such as status and callback URL.
Note: This field may return null, indicating that no valid values can be obtained.

VoiceFilterStatisticsItem

Phrase Filtering usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
Duration Integer Total duration of phrase filtering (in minutes)

VoiceMessageConf

Configuration information of Voice Message Service

Used by actions: CreateApp.

Name Type Required Description
Status String No Voice Message Service status. Valid values: open, close.
Language String No Language supported for Voice Message Service. Valid values: all (all languages), cnen (Chinese and English). Default value: cnen.

VoiceMessageStatisticsItem

Voice Message Service usage statistics

Used by actions: DescribeAppStatistics.

Name Type Description
Dau Integer DAUs of Voice Message Service
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy