获取 WebSocket 音频推送设置

获取 WebSocket 音频推送功能设置, 包括 WebSocket 服务器地址，传输采样率，订阅对象等。

请求 URL

GET {base_url}/{api_path}/websocketaudiostream/get?access_token={access_token}

请求参数

无请求参数。直接发送请求 URL 获取 WebSocket 音频推送功能设置。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
config Object<Audiostream_Setting> WebSocket 音频流的推送设置。
subscribe_list Array <Subscribed_Object> 订阅对象的详细信息。
Audiostream_Setting
参数 类型 说明
enable Integer 是否已启用 WebSocket 音频推送功能。
  • 0：禁用
  • 1：启用
websocket_url String 用于接收音频流的 WebSocket 服务器地址。
auth_key String 第三方平台所需的鉴权字段的名称。
auth_value String 鉴权值。
sample_rate Integer 采样率。
  • 0：8000Hz
  • 1：16000Hz
enable_ext Integer 是否订阅了分机。
  • 0：禁用
  • 1：启用
enable_trunk Integer 是否订阅了中继。
  • 0：禁用
  • 1：启用
enable_did Integer 是否订阅了 DID 号码。
  • 0：禁用
  • 1：启用
Subscribed_Object
参数 类型 说明
id Integer 订阅对象的序列号。
subscribe_type String 订阅对象的类型。
  • extension：分机
  • ext_group：分机组
  • organization：部门
  • trunk：中继
  • did：DID 号码
subscribe_id Integer 订阅对象的唯一 ID。

示例

请求示例

GET /openapi/v1.0/websocketaudiostream/get?access_token=HaRtYPeUXp2otAUzEqUQ4KvISuDOCYBl HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "config": {
        "enable": 1,
        "websocket_url": "wss://docs.example.cloud.com",
        "auth_key": "Secret",
        "auth_value": "Standardpassword111",
        "sample_rate": 0,
        "enable_ext": 1,
        "enable_trunk": 0,
        "enable_did": 0
    },
    "subscribe_list": [
        {
            "id": 3,
            "subscribe_type": "organization",
            "subscribe_id": 2
        },
        {
            "id": 4,
            "subscribe_type": "organization",
            "subscribe_id": 3
        }
    ]
}