tencent cloud

Tencent Real-Time Communication

소식 및 공지 사항
제품 업데이트
Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가
TRTC 월간 구독 패키지 출시 관련 안내
제품 소개
제품 개요
기본 개념
제품 기능
제품 장점
응용 시나리오
성능 데이터
구매 가이드
Billing Overview
무료 시간 안내
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
과금 FAQ
Refund Instructions
신규 사용자 가이드
Demo 체험
Call
개요(TUICallKit)
Activate the Service
Run Demo
빠른 통합(TUICallKit)
오프라인 푸시
Conversational Chat
온클라우드 녹화(TUICallKit)
AI Noise Reduction
UI 사용자 정의
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
릴리스 노트
FAQs
라이브 스트리밍
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo 실행
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK 다운로드
API 코드 예시
Usage Guidelines
API 클라이언트 API
고급 기능
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
콘솔 가이드
애플리케이션 관리
사용량 통계
모니터링 대시보드
개발 보조
Solution
Real-Time Chorus
FAQs
과금 개요
기능 관련
UserSig 관련
방화벽 제한 처리
설치 패키지 용량 축소 관련 질문
Andriod 및 iOS 관련
Web 관련
Flutter 관련
Electron 관련
TRTCCalling Web 관련
멀티미디어 품질 관련
기타 질문
Protocols and Policies
컴플라이언스 인증
보안 백서
정보 보안에 관한 참고 사항
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
용어집

Set Room Metadata

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-26 17:22:03

Feature Overview

App administrator can set room metadata through this interface.

API Calling Description

Sample request URL

https://xxxxxx/v4/live_engine_http_srv/set_room_metadata?
sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The table below only lists the parameters modified when this interface is called. For more details on other parameters, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Others in China: console.tim.qq.com
Singapore : adminapisgp.im.qcloud.com
United States: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/set_room_metadata
Request API.
sdkappid
SDKAppID assigned by the Chat console when an app is created.
identifier
Must be an App admin account. For more details, see App Admin.
usersig
The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format fixed value: json.

Maximum calling frequency

200 queries/sec.

Sample request packets

Basic Form
{
"RoomId": "live-room",
"Metadata": [ // The key count is limited to 10, with each key length restricted to 50 bytes or less. Individual values can be up to 2KB in size, while the aggregate size of all values should not surpass 16KB.
{
"Key":"key1", //If the key exists, it will be updated; otherwise, it will be added
"Value":"value1"
},
{
"Key":"key2",
"Value":"value2"
}
]
}

Request packet fields

Field
Type
Attribute
Description
RoomId
String
Mandatory
Room ID.
Metadata
Array
Mandatory
Room metadata list,the key count is limited to 10, with each key length restricted to 50 bytes or less. Individual values can be up to 2KB in size, while the aggregate size of all values should not surpass 16KB.

Sample response packets

Basic Form
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

Response Packet Field Description

Field
Type
Description
ActionStatus
String
The result of the request process: OK indicates success; FAIL indicates failure.
ErrorCode
Integer
Error code. 0: success; other values: failure.
ErrorInfo
String
Error message.
RequestId
String
Unique Request ID is returned with each request and required to provide this RequestId when locating issues.

Error codes

Unless a network error occurs (e.g., 502 Error), the HTTP return code for this interface will always be 200. The actual error code and error information are indicated in the response payload by ErrorCode and ErrorInfo. Common Error Codes (60000 to 79999) can be found in the Error Codes document. The private error codes for this API are as follows:
Error code
Description
100001
Internal server error, please retry.
100002
Invalid parameter, please check the request for correctness based on the error description.
100006
No permission to operate room metadata.
100007
No payment information, a package bundle needs to be purchased from the Console.
100500
The number of keys for room metadata exceeds the upper limit of 10.
100501
The value of a single key for room metadata exceeds the upper limit of 2KB.
100502
The total size of values for all keys of room metadata exceeds the upper limit of 16KB.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック