Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Control/ Process

Updated on 2025-12-08 GMT+08:00

View PDF

Process

Flowcharts

The following flow charts show the intelligent interaction between a user and a virtual avatar. See About the Flowcharts for details.

Figure 1
Figure 2
Figure 3
Figure 4
Figure 5
Figure 6
Figure 7

WebSocket APIs describes the WebSocket APIs of control for intelligent interaction.

Figure 1 Flow chart of non-streaming control for intelligent interaction

Figure 2 Flow chart of streaming control for intelligent interaction

Figure 3 Flow chart of interrupting a dialog during intelligent interaction

Figure 4 Flow chart of stopping a dialog during intelligent interaction

Figure 5 Flow chart of heartbeat keepalive during intelligent interaction

Figure 6 Flow chart of handling control timeout during intelligent interaction

Figure 7 Flow chart of ending a control task for intelligent interaction

About the Flowcharts

How the APIs in Flowcharts work is described as follows:

Requesting for Establishing a WebSocket Connection
Sending a Message for Text Control
Sending a Message for Interrupting a Dialog
Sending a Message for Stopping a Dialog
Sending a Heartbeat Request
Disconnection Due to Dialog Timeout
Ending a Dialog Task

Requesting for Establishing a WebSocket Connection

When a user requests for establishing a WebSocket connection, the API WebSocket APIs will be called to create a WebSocket connection with the MetaStudio intelligent interaction service.

After the connection is established, the MetaStudio intelligent interaction service is ready and the command START_CHAT will be sent to the third-party application. After the third-party application receives START_CHAT, the user starts to send the command for text control.

Interaction process:

The user requests for establishing a WebSocket connection for a dialog with a virtual avatar.

Code example:

wss://metastudio-api.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/chat-command/e37a28485f684769aa537466e719629d

After receiving the request for establishing a WebSocket connection, MetaStudio returns a response.

Code example:

{
    "error_code": "MSS.00000000",
    "error_msg": "success",
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf"
}

MetaStudio sends a message for starting a dialog.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "START_CHAT",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

Sending a Message for Text Control

A third-party application uses the command TEXT_DRIVE to send a message for text control to the MetaStudio intelligent interaction service.

The field chat_id is returned in the message START_CHAT sent by MetaStudio. When a user sends a message for text control (TEXT_DRIVE), interrupting a dialog (INTERRUPT_CHAT), or stopping a dialog (STOP_CHAT), chat_id must be included in the message.
Streaming text messages are supported. seq indicates the sequence number of the streaming text and starts from 1. is_last indicates whether the data is of the last packet of the streaming text. If streaming text messages are not used, set seq to 1 and is_last to true.
If the data length of each packet is no longer than six characters, the virtual avatar may speak with lags.

Interaction process:

The user sends a message for text control.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "job_id": "e37a28485f684769aa537466e719629d",
        "robot_id": "2c9d60818b365847018b365f40320000",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
        "command": "TEXT_DRIVE",
        "data": {
            "text": "Hello, I'm your virtual avatar",
            "seq": 1,
            "is_last": true
        }
    }
}

After receiving the message for text control, MetaStudio returns a response.

Code example:

{
    "error_code": "MSS.00000000",
    "error_msg": "success",
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "TEXT_DRIVE_RSP",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

After receiving MetaStudio's response, the virtual avatar starts speaking. MetaStudio sends a message for starting speaking.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "START_SPEAKING",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

After the virtual avatar finishes speaking, MetaStudio sends a message for stopping speaking.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "STOP_SPEAKING",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

Sending a Message for Interrupting a Dialog

When a virtual avatar is speaking as instructed by the input text, the command INTERRUPT_CHAT can be executed to interrupt the dialog between the virtual avatar and the user. After the dialog is interrupted, the virtual avatar stops speaking and sends the message START_CHAT for the next dialog to the user.

Interaction process:

The user sends a message for interrupting a dialog.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
        "command": "INTERRUPT_CHAT"
    }
}

After receiving the message for interrupting a dialog, MetaStudio returns a response.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "INTERRUPT_CHAT_RSP",
        "job_id": "e37a28485f684769aa537466e719629d,
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

MetaStudio returns a message for interrupting a dialog to the user.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "STOP_SPEAKING",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

MetaStudio sends a message for starting the next dialog.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "START_CHAT",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "00f1c200389e434485260777a2ad57bc",
    }
}

Sending a Message for Stopping a Dialog

When a virtual avatar is speaking as instructed by the input text, the command STOP_CHAT can be executed to stop the dialog. After the dialog stops, the virtual avatar stops speaking and will not send the message START_CHAT for the next dialog.

Interaction process:

The user sends a message for stopping a dialog.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
        "command": "STOP_CHAT"
    }
}

After receiving the message for stopping a dialog, MetaStudio returns a response.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "STOP_CHAT_RSP",
        "job_id": "e37a28485f684769aa537466e719629d,
        "chat_id": "ac71c539395b4446865074589ffa2c6c"
    }
}

MetaStudio returns a message for stopping a dialog to the user.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "STOP_SPEAKING",
        "job_id": "e37a28485f684769aa537466e719629d",
        "chat_id": "ac71c539395b4446865074589ffa2c6c",
    }
}

Sending a Heartbeat Request

When a virtual avatar is speaking as instructed by the input text, the command PING can be executed to send a heartbeat request to keep the WebSocket connection alive.

Interaction process:

Send a heartbeat request.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "job_id": "e37a28485f684769aa537466e719629d",
        "command": "PING"
    }
}

After receiving the heartbeat request sent by the user, MetaStudio returns a heartbeat response.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "PONG",
        "job_id": "e37a28485f684769aa537466e719629d
    }
}

Disconnection Due to Dialog Timeout

After a WebSocket connection is established between a user and MetaStudio, if the user does not send a dialog message or heartbeat request within 30 seconds, that is, MetaStudio does not receive the command TEXT_DRIVE or PING from a third-party application within 30 seconds, MetaStudio will disable the WebSocket connection.

Ending a Dialog Task

When the intelligent dialog service on MetaStudio ends, for example, the application or its dialog page is closed, MetaStudio sends the command JOB_FINISHED to the third-party application and disables the WebSocket connection.

MetaStudio sends a message for ending the task.

Code example:

{
    "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
    "payload": {
        "command": "JOB_FINISHED",
        "job_id": "e37a28485f684769aa537466e719629d
    }
}

Parent Topic: Intelligent Interaction Control

Previous topic: Prerequisites

Next topic: WebSocket APIs