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 APILive Session ManagementQuerying the Session List under UIN

Querying the Session List under UIN

PDF
Focus Mode
Font Size
Last updated: 2024-07-19 10:01:45
 It is used to query all ongoing session information for a specific UIN account.

Calling Protocol

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

Request Parameters

Parameter name
Type
Required
Description
ReqId
String
Yes
Unique identifier for each request, a 32-character UUID.

Response Parameter

Parameter name
Type
Required
Description
ReqId
String
Yes
Unique identifier for a single request.
Sessions
Yes
Session list array
Session
Name
Type
Required
Description
UserId
String
Yes
User's unique identifier
SessionId
String
Yes
Unique identifier for the session.
SessionStatus
int
Yes
Stream status.1: in progress; 2: closed; 3: preparing; 4: stream creation failed
PlayStreamAddr
String
No
Stream playback address, returned upon successful stream creation
DriverType
String
Yes
Digital human type. 1: text-driven; 3: voice-driven (original sound).
IsSessionStarted
bool
Yes
It indicates whether the session has started. Drive instructions can only be sent when the session is active.

Request Sample

{
    "Header": {},
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
    }
}

Response Sample

{
    "Header": {
        "Code": 0,
        "Message": "",
        "RequestID": "123",
    },
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
        "Sessions": [
            {
                "UserId": "abc",
                "SessionId": "m123",
                "SessionStatus": 1,
                "PlayStreamAddr": "rtmp://live.qq.com/live/m789",
                "DriverType": 1,
                "IsSessionStarted": true
            }
        ]
    }
}

Previous Topic: Querying the Conversion List under the Personal Asset ImageNext Topic: Instruction Sending Requirements

Help and Support

Was this page helpful?

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

Feedback