tencent cloud

Querying the Session List under UIN
Download PDF
Last updated: 2024-07-19 10:01:45
Querying the Session List under UIN
Last updated: 2024-07-19 10:01:45
Download PDF
 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
            }
        ]
    }
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback