- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
It is used to query the current status of a specified session.
Calling Protocol
HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/statsession
Header Content-Type: application/json;charset=utf-8
Request Parameters
Parameter name | Required | Type | Description |
ReqId | Yes | String | Unique identifier for each request, a 32-character UUID. |
SessionId | Yes | String | Unique identifier for the session. |
Response Parameter
Parameter name | Required | Type | Description |
ReqId | Yes | String | Unique identifier for a single request. |
SessionStatus | Yes | int | Stream status.1: in progress; 2: closed; 3: preparing; 4: stream creation failed |
PlayStreamAddr | No | string | Streaming playback address |
SpeakStatus | No | string | Status of the digital human. Initial: initial state. WaitingTextStart: waiting for text broadcast to start. TextStart: text broadcasting. WaitingTextOver: waiting for text broadcast to finish. TextOver: text broadcast finished. WaitingAudioStart: waiting for audio broadcast to start. AudioStart: audio broadcast started. WaitingAudioOver: waiting for audio broadcast to finish. AudioOver: audio broadcast finished. Error: drive error (same as TextOver and AudioOver, indicating the end state of a drive). It only denotes the failure of the most recent drive command and does not affect the ability to continue sending drive commands. |
IsSessionStarted | Yes | bool | It indicates whether the session has started. Drive instructions can only be sent when the session is active. Note: |
ErrorCode | Yes | int | The error code corresponding to the current status; 0 indicates normal operation. See Section 7.2 for the list of error codes. |
ErrorMessage | No | string | The error message corresponding to the current status. |
Request Sample
{"Header": {},"Payload": {"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf","SessionId": "m123"}}
Response Sample
{"Header": {"Code": 0,"Message": "","RequestID": "123",},"Payload": {"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf","SessionStatus": 1,"PlayStreamAddr": "rtmp://live.qq.com/live/m789","SpeakStatus": "TextOver","IsSessionStarted": true,"ErrorCode": 0,"ErrorMessage": ""}}
Yes
No
Was this page helpful?