This documentation primarily describes the open API protocol for the TCADH Interaction aPaas platform.
Notes
Before calling this API, please make sure you have purchased the product in the red box below:
API Calling Methods
When calling each API, you need to pass in common parameters and a signature in the query of the API. For an explanation of the parameters and signature methods, see the following link:
API Integration Process
The integration process is divided into two parts: session management and instruction-driven API docking.
Live session management can handle creating live sessions, closing live sessions, querying the status of live sessions, querying the session list, etc.
Sending instruction-driven commands can enable the digital human to speak and broadcast, and it can also provide real-time updates on the speaking status of the digital human.
Integration Guide:
Step 1: Activate a digital human platform account. For activation methods, see Purchase Guide. Step 3: If the status returned in Step 2 is 1, skip this step; if the status returned in Step 2 is 3, then poll the Query Session Status API to find the streaming address. Step 4: Start the player to pull and play the stream.
Step 5: Call the Start Session API to set the session to the ready-to-drive state. Step 6: Use the Instruction-driven API to drive the digital human to broadcast and receive downstream status messages, observing the driving effect. Step 7: If the interaction is finished, call the Close Live Session API to release concurrency.
Was this page helpful?