tencent cloud

Tencent Cloud AI Digital Human

Product Overview
Overview
Product Features
Product Advantage
Purchase Guide
Pricing Guide
Purchase Guide
Process for Purchasing with Vouchers
Refund Instructions
Introduction of Avatar
Introduction to Image Categories
Basic Image Library
Guide on Avatar and Voice Clone
Digital Human Platform Operation Guide
Accessing Platform
Avatar Production and Asset Management
Digital Human Conversation Interaction Application and Management
Broadcast Digital Human Video Generation and Management
Operations Management and Analysis
Server API Integration
Digital Human API Access Mode Overview
Avatar aPaas API Calling Methods
Avatar Image Customization and Voice Clone API Documentation
Video Generation Service API Documentation
Interactive Digital Human Service API Documentation
Personal Asset Management API Documentation
Client SDK Integration
Overall Introduction
3D Client-Side Rendering SDK Integration
2D Client-Side Rendering SDK Integration
Digital Human SSML Markup Language Specification
Related Agreement
Privacy Policy
DSA (Data Sharing Agreement)
FAQs
DocumentationTencent Cloud AI Digital HumanServer API IntegrationInteractive Digital Human Service API DocumentationCloud Rendering Conversation Interaction Integration APIOther APIsObtaining the Key to the TRTC Room

Obtaining the Key to the TRTC Room

PDF
Focus Mode
Font Size
Last updated: 2024-07-19 10:14:53
When a live session is created and the TRTC protocol is selected, this API is used by users other than the Digital Human to obtain the key for entering the room.
Note:
This only applies to situations where the internal TRTC account of the digital human is used.

Calling Protocol

HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/gettrtcsign
Header Content-Type: application/json;charset=utf-8

Request Parameters

Parameter name
Required
Type
Description
ReqId
Yes
String
Unique identifier for a single request.
SessionId
Yes
string
Session ID.
RoomId
Yes
string
The room ID, obtained through API 4.1 and parsed from the returned addr address.
UserId
Yes
string
User ID for entering the room.

Response Parameter

Parameter name
Required
Type
Description
ReqId
Yes
String
Unique identifier for a single request.
UserSig
Yes
string
Room Key.
PrivateMapKey
Yes
string
Permission Key.

Request Sample

{
    "Header": {},
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
        "SessionId": "12123132",
        "RoomId": "1200111",
        "UserId": "avcvdafasfds",
    }
}

Response Sample

{
    "Header": {
        "Code": 0,
        "Message": "",
        "RequestID": "123",
    },
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
        "UserSig": "vafdasfda",
        "PrivateMapKey": "fdasfdafdasfdasfd"
    }
}

Previous Topic: Text-driven InstructionsNext Topic: Error Code Description

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback