voiceChat

提供流式语音对话 WebSocket OpenAPI，向智能体发起语音对话。双向流式语音对话场景下的各类事件，详细信息可参考：

• 上行事件

• 下行事件

接口信息

URL	wss://ws.xxx.com/soulmate/voiceChat/v1
权限说明	语音对话

请求参数

Header

字段名称	类型	必选	说明
Authorization	string	是	Bearer ${accessToken} 获取方式参考获取授权页面

请求示例

wss://ws.xxx.com/soulmate/voiceChat/v1?botId={botId}&sessionId={sessionId}&requestId={requestId}

参数说明

字段名称	类型	必选	说明
botId	string	是	设备唯一标识。创建方式1: https://xxx.com/bots 手动创建，方式2: 设备注册接口
requestId	string	是	请求唯一标识。建议使用UUID
sessionId	string	是	会话唯一标识。关联用户和智能体对话的所有聊天记录，建议用uid+botId标识一次会话
needManualCall	boolean	否	手动模式（依赖客户端控制），传值：true，该模式客户端需对接CLIENT_AUDIO_FINISH和CLIENT_INTERRUPT（打断语音回复时使用）
location	string	否	位置信息

建立链接示例

Python版本

import json
import threading
import uuid
import websocket

sessionId = str(uuid.uuid4())
botId = ""
requestId = str(uuid.uuid4())
uid = "123456"
PING = {"mid": requestId, "contentType": "PING", "uid": uid}


def on_message(ws, message):
    print("Received:", message)


def on_error(ws, error):
    print("Error:", error)


def on_close(ws, close_status_code, close_msg):
    print("WebSocket closed")


def on_open(ws):
    def run(*args):
        ws.send(json.dumps(PING))

    threading.Thread(target=run).start()


if __name__ == "__main__":
    ws_url = "wss://ws.xxx.com/soulmate/voiceChat/v1?botId=%s&sessionId=%s&requestId=%s" % (botId, sessionId, requestId)
    print(ws_url)

    ws = websocket.WebSocketApp(
        ws_url,
        header=[
            f"Authorization: Bearer test.eyDg4OTJ9.6TyD"],
        on_open=on_open,
        on_message=on_message,
        on_error=on_error,
        on_close=on_close
    )
    ws.run_forever()

API交互时序

交互流程图

相关链接：

• 上行事件

• 下行事件