物联网开发平台自定义房间id创建TRTC通话参数-其他接口-API 中心-腾讯云

1. 接口描述

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

创建TRTC通话参数

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateTRTCSignaturesWithRoomId。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
TRTCUserIds.N	是	Array of String	TRTC进房间的用户名称数组，数组元素不可重复，最长不超过 10 个。示例值：["test123","test1234"]
RoomId	是	String	房间id 示例值：room1

3. 输出参数

参数名称	类型	描述
TRTCParamList	Array of TRTCParams	返回参数数组注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

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

{
    "TRTCUserIds": [
        "test1"
    ],
    "RoomId": "test"
}

输出示例

{
    "Response": {
        "RequestId": "keyixie_38bc26eb-89c5-4e7c-bdb3-9a4fe25e719f",
        "TRTCParamList": [
            {
                "SdkAppId": 111111,
                "UserId": "test1",
                "UserSig": "eJwszcvOgjAQBe123213131321313QRN5AbRVR6U2dIK3*O4mwPY7Oed8oF7vEvcM1DkweaYR-wci6zzTkVwHBthFFjAG0V6bEMiCERpR1232132132133xio-CtUdsOqx*WlYb8-z95-BcsYtyVa2RYrcbjd6adadsadsadvmo-XAtE4TvLwAA--*MzTGH",
                "StrRoomId": "gl-40badb65asdsadasdsad40b2192f948845",
                "PrivateKey": "eJw0j19PszAUxr-LuX3fjFJahk12UaxUzVplwha4c2nHCtlC*KPbjN-dOObv8ndynjzPF2TLt5k9ta6zwKKQIPT-qpyxx8HtnO2AwWD7wYfp0JvmvW2dAeYThAgJg7vbS*8qYNALlMdbj*5THev546k4yvu5RkRG-0wbea-Pm2rs6mVdoABT3li5PpiRJLZFcb8F5loRwvOufD4RFfiz0GL2BWbldN17peHgqrLAyrleq*xwkrkROMUKfl0VllzLusGvYgK6XTxV*XjuhfPEHz-BAAA--9iV1Mr"
            }
        ]
    }
}

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. 错误码

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

错误码	描述
InvalidParameter.RoomIdExist	RoomId已存在
InvalidParameter.UserIdOverLimit	UserId数量超出限制
UnsupportedOperation.TRTCServiceNotOpen	TRTC增值服务未开通