天翼云智能视图服务API

1. 开启语音对讲

接口功能介绍

本接口用于开启设备语音对讲。语音对讲使用步骤如下：

调用该API获取发送音频数据的ws地址（即AudioUrl参数的返回值）。
向返回的ws地址发送音频，可参考web前端音频采集的demo（音频demo下载）。

demo 使用流程：

解压 intercom-demo.zip。
命令行 cd 到 Intercom-demo。
输入命令 npm install （如已安装 node）；如未安装 node，在nodejs 官方网站下载安装，版本 16 及以上即可。
安装完成后，命令行输入 npm run dev ，待运行完成看到 successfully 后，浏览器输入http://locolhost:8080。
在打开的页面内依次输入 websocket 链接和deviceId 后，点击按钮开始发送音频，松开按钮则停止发送。

接口约束

仅支持gb28181、ehome设备。
通过该API获取ws地址（即AudioUrl参数的返回值）后，须在5秒内发送音频数据，否则地址将失效。
发送的音频数据编码格式为pcm，可参考web前端音频采集的demo。
单次数据包不得超过 5000 字节（约 0.3 秒 PCM16 音频，采样率 8kHz，16bit 单声道），如果超过该限制，系统将主动关闭 WebSocket 连接，并返回 "streamserver error"。
音频首包发送StreamName。该值通过本接口返回字段StreamName获取。

URI

POST /devices/{DeviceId}/startTalk

路径参数

参数	是否必填	参数类型	说明	示例	下级对象
DeviceId	是	String	设备ID。	1138672323552296961

Query参数

无

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例
Authorization	是	String	认证信息。	CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-Type	是	String	互联网媒体类型。	application/json;charset=utf-8
Host	是	String	主机。	vssapi.ctyun.cn
Version	是	String	版本。	2021-11-25
Timestamp	是	String	时间戳。	1689643309

请求体body参数

参数	是否必填	参数类型	说明	示例
TransPriority	否	String	传输优先级。取值tcp或udp。默认tcp。	tcp
AudioKey	否	String	语音对讲KEY，用于停止语音对讲的唯一key（10位数字、字母随机字符串）。	zCmKKfNI1j
OutNetwork	否	String	语音对讲网络类型；默认 internet 。取值：internet：互联网；vpn：专线网络。	internet/vpn

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。	200
error	String	错误码，执行成功时，不返回该字段。	VSS_0001
message	String	响应信息。	请求成功
requestId	String	请求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	响应数据，执行失败时，不返回该字段。		returnObj

表 returnObj

参数	参数类型	说明	示例
AudioUrl	String	语音对讲地址。	ws://vssapi.ctyun.cn/talk/1293604747542364160_audio
AudioKey	String	语音对讲KEY，如果请求参数AudioKey为空，则系统随机生成10位随机串。	zCmKKfNI1j
StreamName	String	发送音频首包数据需要。	`1293604747542364160_audio`
RequestId	String	请求ID。	03f07edc8d414fb1ba561c0831226289

请求示例

请求url

POST '/devices/1293604747542364160/startTalk'

请求头header

{
  "Authorization": "CT-HMAC-SHA256 Credential=SBGX5QWGRAC5QMDQUXIZ/2023-06-15/vss, SignedHeaders=content-type;host;timestamp, Signature=581a85517ab9a684c5250d97a3a587e272ad4fc9ab9c1197a57f78b97e2d7a53",
  "Content-Type": "application/json;charset=utf-8",
  "Host": "vssapi.ctyun.cn",
  "Version": "2021-11-25",
  "Timestamp": "1689643309"
}

请求体body

{
  "AudioKey": "zCmKKfNI1j",
  "TransPriority": "udp"
}

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "03f07edc8d414fb1ba561c0831226289",
  "returnObj": {
    "AudioUrl": "ws://vssapi.ctyun.cn/talk/1293604747542364160_audio?auth_key=NMDTe%2FEk7cu4EN%2F2CHnpH5bkVzJke%2BghH67uzZ1poRU%3D&timestamp=1750229449",
    "AudioKey": "zCmKKfNI1j",
    "StreamName": "1293604747542364160_audio",
    "RequestId": "03f07edc8d414fb1ba561c0831226289"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

开启语音对讲

最近更新时间：2026-03-19 18:16:28

天翼云智能视图服务API

1. 开启语音对讲

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码