游戏多媒体引擎修改用户麦克风状态-服务端 API-文档中心-腾讯云

1. 接口描述

接口请求域名： gme.tencentcloudapi.com 。

接口作用：此接口用于修改房间用户的麦克风状态，例如房间内用户麦克风为打开状态，可调用此接口将该用户麦克风进行关闭，关闭后即使该用户使用客户端接口 EnableMic 打开麦克风，依然无法与房间内成员通话，属于被禁言状态。该状态持续到此用户退房后失效，或者调用该接口重新打开此用户麦克风状态。
接口应用场景：此接口多用于游戏业务中台或者风控后台，对一些发表不当言论的玩家进行禁言处理。
接口使用前提：目前 ModifyUserMicStatus 接口通过白名单开放，如需使用，需要提交工单申请。

默认接口请求频率限制：200次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyUserMicStatus。
Version	是	String	公共参数，本接口取值：2018-07-11。
Region	否	String	公共参数，此参数为可选参数。
BizId	是	Integer	来自腾讯云控制台的 GME 服务提供的 AppID，获取请参考语音服务开通指引。示例值：0
RoomId	是	String	实时语音房间号。示例值：11
Users.N	是	Array of UserMicStatus	需要操作的房间内用户以及该用户的目标麦克风状态。

3. 输出参数

参数名称	类型	描述
Result	Integer	返回结果：0为成功，非0为失败。示例值：0
ErrMsg	String	错误信息。示例值：123
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改用户麦克风属性

修改用户麦克风属性

输入示例

POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUserMicStatus
<公共请求参数>

{
    "BizId": 1400000000,
    "RoomId": "300",
    "Users": [
        {
            "Uid": 1111,
            "EnableMic": 1,
            "StrUid": ""
        }
    ]
}

输出示例

{
    "Response": {
        "Result": 0,
        "ErrMsg": "",
        "RequestId": "f2c37dfd-56c9-400e-9fbc-705db7a74af8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
ResourceNotFound	资源不存在。

修改用户麦克风状态

本页目录：