智能交互驱动WebSocket接口

终端节点

调用当前接口的访问地址，如表1所示。

功能介绍

该接口用于创建用户与数字人对话的WebSocket连接，驱动数字人对话。

调用方法

可选用下述一种方法，调用本接口：

• IAM Token认证方式，操作请参考如何调用API。
• 一次性Token认证方式，操作请参考创建一次性鉴权码。

URI

/v1/{project_id}/digital-human-chat/chat-command/{job_id}

表2、表3和表4是WebSocket建连时携带的参数。

请求参数

表5、表6和表7中的请求参数为WebSocket建连成功后，用户与数字人对话的请求参数。

响应参数

状态码： 101

请求示例

1. 用户请求建立与数字人对话的WebSocket连接。

   代码示例如下所示：

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

2. 等MetaStudio返回可以发送启动对话的消息时，如2所示。用户发送文本驱动消息。
   代码示例如下所示：

   {
       "request_id": "d7aa08da33dd4a662ad5be508c5b77cf",
       "payload": {
           "job_id": "e37a28485f684769aa537466e719629d",
           "robot_id": "2c9d60818b365847018b365f40320000",
           "chat_id": "ac71c539395b4446865074589ffa2c6c",
           "command": "TEXT_DRIVE",
           "data": {
               "text": "您好，我是您的分身数字人",
               "seq": 1,
               "is_last": true
           }
       }
   }

响应示例

状态码：101

1. MetaStudio接收WebSocket建立连接的请求后，如1所示，返回响应消息。
   代码示例如下所示：

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

2. MetaStudio发送启动对话的消息。
   代码示例如下所示：

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

3. MetaStudio收到用户发送的文本驱动消息时，如2所示。MetaStudio返回文本驱动的响应消息。
   代码示例如下所示：

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

状态码

错误码

请参见错误码。