- Product Overview
- 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
- 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
- FAQs
- Product Overview
- 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
- 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
- FAQs
Calling Protocol
HTTPS + JSON
POST /v2/ivh/interactdriver/interactdriverservice/command
Header Content-Type: application/json;charset=utf-8
Note:
The interval between sending texts must be greater than 1 second.
Request Parameters
Parameter name | Type | Required | Description |
ReqId | String | Yes | Unique identifier for a single request. |
SessionId | String | Yes | Unique identifier for the session. |
Command | String | Yes | SEND_TEXT: Send text. |
Data | Yes | Data Object |
Data
(Send text.)Name | Type | Required | Description |
Text | string | No | The text content to be broadcasted, default value: "" The string with a maximum length of 4000. |
Interrupt | boolean | No | Forced interruption flag. The default value is false. If forced interruption is not used and the text is marked as non-interruptible on the digital human platform, you will receive feedback indicating that interruption is not possible. If forced interruption is used, the system will ignore the non-interruptible setting on the digital human platform and execute the forced interruption directly. |
ChatCommand | string | No | Dialogue instruction type, effective when the digital human project is bound to a customer service chat bot. NotUseChat: The Q&A knowledge library configured for the customer service bot is not effective, and the digital human broadcasts the content sent. Pass empty or do not pass: The Q&A knowledge library configured for the customer service bot becomes effective, and the digital human broadcasts the answers from the Q&A knowledge library. |
Response Parameter
There is no need to pay attention to the returned content, just focus on the returned error code.
Request Sample
//Send the text message.{"Header": {},"Payload": {"SessionId": "m123","Command": "SEND_TEXT","Data": {"Text": "Hello"}}}//After the customer service chat is bound, don't use the chat; broadcast the content that is sent.{"Header": {},"Payload": {"SessionId": "m123","Command": "SEND_TEXT","Data": {"Text": "Hello","ChatCommand": "NotUseChat"//Using the text-driven stream built for the digital human project; this drive is purely text-driven and does not involve dialogue.}}}//Force interruption{"Header": {},"Payload": {"SessionId": "m123","Command": "SEND_TEXT","Data": {"Interrupt": true}}}
Response Sample
{"Header": {"Code": 0,"Message": "","RequestID": "m123adfafvbadsafd",}}
Yes
No
Was this page helpful?