数据结构

AgeDetectTask

年龄语音识别子任务

被如下接口引用：CreateAgeDetectTask。

名称	类型	必选	描述
DataId	String	是	数据唯一ID 示例值：abcd
Url	String	是	数据文件的url，为 urlencode 编码,音频文件格式支持的类型：.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg 示例值：https://xxx.com/yy.wav

AgeDetectTaskResult

年龄语音任务结果

被如下接口引用：DescribeAgeDetectTask。

名称	类型	描述
DataId	String	数据唯一ID 示例值：abcd
Url	String	数据文件的url 示例值：https://xxx.com/yyy.wav
Status	Integer	任务状态，0: 已创建，1:运行中，2:正常结束，3:异常结束，4:运行超时 示例值：2
Age	Integer	任务结果：0: 成年，1:未成年，100:未知 示例值：1

AppStatisticsItem

应用用量统计数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
RealtimeSpeechStatisticsItem	RealTimeSpeechStatisticsItem	实时语音统计数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"MainLandPcu":0,"MainLandDuration":0,"OverseaPcu":0,"OverseaDur
VoiceMessageStatisticsItem	VoiceMessageStatisticsItem	语音消息统计数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Dau":1018}
VoiceFilterStatisticsItem	VoiceFilterStatisticsItem	语音过滤统计数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Duration" : 18000}
Date	Date	统计时间 示例值：2022-10-01
AudioTextStatisticsItem	AudioTextStatisticsItem	录音转文本用量统计数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Data":0}
StreamTextStatisticsItem	StreamTextStatisticsItem	流式转文本用量数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Data":0}
OverseaTextStatisticsItem	OverseaTextStatisticsItem	海外转文本用量数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Data":0}
RealtimeTextStatisticsItem	RealtimeTextStatisticsItem	实时语音转文本用量数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Data":0}

ApplicationDataStatistics

应用统计数据

被如下接口引用：DescribeApplicationData。

名称	类型	描述
BizId	Integer	应用ID
DauDataNum	Integer	Dau统计项数目
DauDataMainland	Array of StatisticsItem	大陆地区Dau统计数据，单位人
DauDataOversea	Array of StatisticsItem	海外地区Dau统计数据，单位人
DauDataSum	Array of StatisticsItem	大陆和海外地区Dau统计数据汇总，单位人
DurationDataNum	Integer	实时语音时长统计项数目
DurationDataMainland	Array of StatisticsItem	大陆地区实时语音时长统计数据，单位分钟
DurationDataOversea	Array of StatisticsItem	海外地区实时语音时长统计数据，单位分钟
DurationDataSum	Array of StatisticsItem	大陆和海外地区实时语音时长统计数据汇总，单位分钟
PcuDataNum	Integer	Pcu统计项数目
PcuDataMainland	Array of StatisticsItem	大陆地区Pcu统计数据，单位人
PcuDataOversea	Array of StatisticsItem	海外地区Pcu统计数据，单位人
PcuDataSum	Array of StatisticsItem	大陆和海外地区Pcu统计数据汇总，单位人

ApplicationList

获取应用列表返回

被如下接口引用：DescribeApplicationList。

名称	类型	描述
ServiceConf	ServiceStatus	服务开关状态 示例值：[]
BizId	Integer	应用ID(AppID) 示例值：1
AppName	String	应用名称
ProjectId	Integer	项目ID，默认为0 示例值：1
AppStatus	Integer	应用状态，返回0表示正常，1表示关闭，2表示欠费停服，3表示欠费回收 示例值：1
CreateTime	Integer	创建时间，Unix时间戳格式 示例值：1
AppType	Integer	应用类型，无需关注此数值 示例值：1

AsrConf

语音转文本配置数据

被如下接口引用：CreateApp。

名称	类型	必选	描述
Status	String	否	语音转文本服务开关，取值：open/close 示例值：open

AudioTextStatisticsItem

录音转文本用量统计数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Data	Float	统计值，单位：秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.23

CreateAppResp

CreateApp的输出参数

被如下接口引用：CreateApp。

名称	类型	描述
BizId	Integer	应用ID，由后台自动生成。 示例值：123456
AppName	String	应用名称，透传输入参数的AppName 示例值：abcd
ProjectId	Integer	项目ID，透传输入的ProjectId 示例值：0
SecretKey	String	应用密钥，GME SDK初始化时使用 示例值：sdsd
CreateTime	Integer	服务创建时间戳 示例值：123456
RealtimeSpeechConf	RealtimeSpeechConf	实时语音服务配置数据 示例值：{}
VoiceMessageConf	VoiceMessageConf	语音消息服务配置数据 示例值：{}
VoiceFilterConf	VoiceFilterConf	语音分析服务配置数据 示例值：{}
AsrConf	AsrConf	语音转文本服务配置数据 示例值：{}

CustomizationConfigs

语音消息转文本热句模型配置

被如下接口引用：GetCustomizationList。

名称	类型	必选	描述
BizId	Integer	是	应用 ID，登录控制台创建应用得到的AppID 示例值：123
ModelId	String	是	模型ID 示例值：123
ModelState	Integer	是	模型状态，-1下线状态，1上线状态, 0训练中, -2训练失败, 3上线中, 4下线中 示例值：1
ModelName	String	否	模型名称 示例值：ModelName
TextUrl	String	否	文本文件的下载地址，服务会从该地址下载文件，目前仅支持腾讯云cos 示例值：https://file.myqcloud.com/keywords_template.txt
UpdateTime	Integer	否	更新时间，11位时间戳 示例值：1667465928843

DeleteResult

剔除房间操作结果

被如下接口引用：DeleteRoomMember。

名称	类型	描述
Code	Integer	错误码，0-剔除成功 其他-剔除失败
ErrorMsg	String	错误描述

DescribeAppStatisticsResp

获取应用用量统计数据输出参数

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
AppStatistics	Array of AppStatisticsItem	应用用量统计数据 示例值：[]

DescribeScanResult

语音检测结果返回

被如下接口引用：DescribeScanResultList。

名称	类型	描述
Code	Integer	业务返回码 示例值：0
DataId	String	数据唯一 ID 示例值：1234
ScanFinishTime	Integer	检测完成的时间戳 示例值：1234
HitFlag	Boolean	是否违规 示例值：false
Live	Boolean	是否为流 示例值：false
Msg	String	业务返回描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：“”
ScanPiece	Array of ScanPiece	检测结果，Code 为 0 时返回 注意：此字段可能返回 null，表示取不到有效值。 示例值：[]
ScanStartTime	Integer	提交检测的时间戳 示例值：1234
Scenes	Array of String	语音检测场景，对应请求时的 Scene 示例值：["default"]
TaskId	String	语音检测任务 ID，由后台分配 示例值：abcdefgh
Url	String	文件或接流地址 示例值：http://xx.mp3
Status	String	检测任务执行结果状态，分别为： Start: 任务开始 Success: 成功结束 Error: 异常 示例值：Success
BizId	Integer	提交检测的应用 ID 示例值：140011111

Filter

查找过滤

被如下接口引用：DescribeApplicationList。

名称	类型	必选	描述
Name	String	否	要过滤的字段名, 比如"AppName"
Values	Array of String	否	多个关键字

InOutTimeInfo

房间内的事件

被如下接口引用：DescribeUserInAndOutTime。

名称	类型	描述
StartTime	Integer	进入房间时间
EndTime	Integer	退出房间时间

ModifyAppStatusResp

ModifyAppStatus接口输出参数

被如下接口引用：ModifyAppStatus。

名称	类型	描述
BizId	Integer	GME应用ID 示例值：123456
Status	String	应用状态，取值：open/close 示例值：open

OverseaTextStatisticsItem

海外转文本用量数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Data	Float	统计值，单位：秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.23

RealTimeSpeechStatisticsItem

实时语音用量统计数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
MainLandDau	Integer	大陆地区DAU
MainLandPcu	Integer	大陆地区PCU
MainLandDuration	Integer	大陆地区总使用时长，单位为min
OverseaDau	Integer	海外地区DAU
OverseaPcu	Integer	海外地区PCU
OverseaDuration	Integer	海外地区总使用时长，单位为min

RealtimeSpeechConf

实时语音配置数据

被如下接口引用：CreateApp。

名称	类型	必选	描述
Status	String	否	实时语音服务开关，取值：open/close 示例值：open
Quality	String	否	实时语音音质类型，取值：high-高音质 ordinary-普通音质 示例值：high

RealtimeTextStatisticsItem

实时语音转文本用量数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Data	Float	统计值，单位：秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.23

RecordInfo

房间内录制信息。
注意：此字段可能返回 null，表示取不到有效值。

被如下接口引用：DescribeRecordInfo。

名称	类型	描述
UserId	String	用户ID（当混流模式时，取值为0）。 示例值：6787
FileName	String	录制文件名。 示例值：/3400352518_2314_447947346201176660_9081
RecordBeginTime	Integer	录制开始时间（unix时间戳如：1234567868）。 示例值：1234567868
RecordStatus	Integer	录制状态：2代表正在录制 10代表等待转码 11代表正在转码 12正在上传 13代表上传完成 14代表通知用户完成。 示例值：2

RoomUser

房间内用户信息

被如下接口引用：DescribeRoomInfo。

名称	类型	描述
RoomId	Integer	房间id 示例值：1234
Uins	Array of Integer	房间里用户uin列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[123456]
StrRoomId	String	字符串房间id 注意：此字段可能返回 null，表示取不到有效值。 示例值："1234"
StrUins	Array of String	房间里用户字符串uin列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["1234"]

ScanDetail

语音检测详情

被如下接口引用：DescribeScanResultList。

名称	类型	描述
Label	String	违规场景，参照Label定义
Rate	String	该场景下概率[0.00,100.00],分值越大违规概率越高
KeyWord	String	违规关键字
StartTime	Integer	关键字在音频的开始时间，从0开始的偏移量，单位为毫秒，Label=moan时有效
EndTime	Integer	关键字在音频的结束时间，从0开始的偏移量,，单位为毫秒，Label=moan时有效

ScanPiece

语音检测结果，Code 为 0 时返回

被如下接口引用：DescribeScanResultList。

名称	类型	描述
DumpUrl	String	流检测时返回，音频转存地址，保留30min 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx
HitFlag	Boolean	是否违规 示例值：false
MainType	String	违规主要类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：normal
ScanDetail	Array of ScanDetail	语音检测详情
RoomId	String	gme实时语音房间ID，透传任务传入时的RoomId 注意：此字段可能返回 null，表示取不到有效值。 示例值：12345
OpenId	String	gme实时语音用户ID，透传任务传入时的OpenId 注意：此字段可能返回 null，表示取不到有效值。 示例值：12345
Info	String	备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx
Offset	Integer	流检测时分片在流中的偏移时间，单位毫秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
Duration	Integer	流检测时分片时长 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
PieceStartTime	Integer	分片开始检测时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：0

ScanVoiceResult

语音检测返回结果

被如下接口引用：ScanVoice。

名称	类型	描述
DataId	String	数据ID
TaskId	String	任务ID

SceneInfo

SceneInfo场景信息
'RealTime','实时语音分析',
'VoiceMessage','语音消息',
'GMECloudApi':'GME云API接口'

被如下接口引用：CreateApp。

名称	类型	必选	描述

ServiceStatus

服务开关状态

被如下接口引用：DescribeApplicationList。

名称	类型	描述
RealTimeSpeech	StatusInfo	实时语音服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
VoiceMessage	StatusInfo	语音消息服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Porn	StatusInfo	语音内容安全服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Live	StatusInfo	语音录制服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
RealTimeAsr	StatusInfo	语音转文本服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
TextTranslate	StatusInfo	文本翻译服务开关状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

StatisticsItem

用量数据单元

被如下接口引用：DescribeApplicationData。

名称	类型	描述
StatDate	Date	日期，格式为年-月-日，如2018-07-13
Data	Integer	统计值

StatusInfo

服务开关状态

被如下接口引用：DescribeApplicationList。

名称	类型	描述
Status	Integer	服务开关状态， 0-正常，1-关闭

StreamTextStatisticsItem

流式转文本用量数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Data	Float	统计值，单位：秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.23

SubscribeRecordUserIds

指定订阅流白名单或者黑名单。

被如下接口引用：DescribeTaskInfo, ModifyRecordInfo, StartRecord。

名称	类型	必选	描述
UnSubscribeUserIds	Array of String	否	订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表不订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数
SubscribeUserIds	Array of String	否	订阅音频流白名单，指定订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。 注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数。

Tag

标签列表

被如下接口引用：CreateApp, DescribeApplicationList。

名称	类型	必选	描述
TagKey	String	否	标签键 注意：此字段可能返回 null，表示取不到有效值。
TagValue	String	否	标签值 注意：此字段可能返回 null，表示取不到有效值。

Task

语音检测任务列表

被如下接口引用：ScanVoice。

名称	类型	必选	描述
DataId	String	是	数据的唯一ID
Url	String	是	数据文件的url，为 urlencode 编码，流式则为拉流地址
RoomId	String	否	gme实时语音房间ID，通过gme实时语音进行语音分析时输入
OpenId	String	否	gme实时语音用户ID，通过gme实时语音进行语音分析时输入

UserMicStatus

用户麦克风状态

被如下接口引用：ModifyUserMicStatus。

名称	类型	必选	描述
EnableMic	Integer	是	开麦状态。1表示关闭麦克风，2表示打开麦克风。 示例值：1
Uid	Integer	否	客户端用于标识用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。） 示例值：9798
StrUid	String	否	客户端用于标识字符串型用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。） 示例值：jelly

VoiceFilterConf

语音过滤服务配置数据

被如下接口引用：CreateApp。

名称	类型	必选	描述
Status	String	否	语音过滤服务开关，取值：open/close
SceneInfos	Array of SceneInfo	否	场景配置信息，如开关状态，回调地址。 注意：此字段可能返回 null，表示取不到有效值。

VoiceFilterStatisticsItem

语音过滤用量统计数据

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Duration	Integer	语音过滤总时长，单位为min 示例值：100

VoiceMessageConf

离线语音服务配置数据

被如下接口引用：CreateApp。

名称	类型	必选	描述
Status	String	否	离线语音服务开关，取值：open/close
Language	String	否	离线语音支持语种，取值： all-全部，cnen-中英文。默认为中英文

VoiceMessageStatisticsItem

语音消息用量统计信息

被如下接口引用：DescribeAppStatistics。

名称	类型	描述
Dau	Integer	离线语音DAU