获取创建 WebRTC 连接的配置

更新时间:2023-07-10 02:56:37下载pdf

本文介绍获取创建 WebRTC 连接配置的 API。

接口描述

获取创建 WebRTC 连接的配置信息。

接口地址

GET: /v1.0/devices/{device_id}/webrtc-configs

请求参数

参数名 类型 参数位置 是否必填 说明
device_id String uri true 设备 ID

返回参数

参数名 类型 说明
result WebRTCConfigVO 返回结果

result 说明

参数名 类型 说明
audio_attributes JSONObject 音频属性
auth String 授权码
id String 设备 ID
moto_id String 信令服务 ID
p2p_config JSONObject P2P 配置
skill String 技能
supports_webrtc Boolean 是否支持 WebRTC
vedio_clarity Integer 视频清晰度

p2p_config 说明

参数名 类型 说明
ices List ICE 信息

audio_attributes 说明

参数名 类型 说明
call_mode List 呼叫模式
hardware_capability List 硬件能力

ices 说明

参数名 类型 说明
urls String 服务器地址
username String 用户名
credential String 密码
ttl Integer 有效时长

请求示例

GET: /v1.0/devices/6c08578d894xxxx11afye1/webrtc-configs
{}

返回示例

{
    "result": {
        "p2p_config": {
            "ices": [
                {
                    "urls": "stun:172.81.239.63:****"
                },
                {
                    "urls": "stun:tx1stun.wgine.com:****"
                },
                {
                    "urls": "nat:tx1nat.wgine.com:****"
                },
                {
                    "urls": "nat:tx1nat.tuyacn.com:****"
                },
                {
                    "ttl": 3600,
                    "urls": "turn:172.81.239.63:3478",
                    "credential": "+eszzFb3f+KM7N5f+/3jdCHl****",
                    "username": "1615438498:6c08578d894934411afye1:kydhkuwwehqrvd8p****"
                },
                {
                    "ttl": 3600,
                    "urls": "turn:tx1turn.wgine.com:****",
                    "credential": "+eszzFb3f+KM7N5f+/3jdCHl****",
                    "username": "1615438498:6c08578d894934411afye1:kydhkuwwehqrvd8p****"
                }
            ]
        },
        "auth": "U+qtvRP+Amz3YQLpcgagMxqID8aUGBUZopKJr0kW****",
        "supports_webrtc": true,
        "skill": "{\"webrtc\":3,\"audios\":[{\"channels\":1,\"dataBit\":16,\"codecType\":105,\"sampleRate\":8000}],\"videos\":[{\"streamType\":2,\"profileId\":\"\",\"width\":2304,\"codecType\":4,\"sampleRate\":0,\"height\":1296},{\"streamType\":4,\"width\":640,\"codecType\":2,\"sampleRate\":0,\"height\":360}]}",
        "moto_id": "moto_cnpre002",
        "id": "6c08578d894934411a****",
        "vedio_clarity": 4,
        "audio_attributes": {
            "call_mode": [
                1,
                2
            ],
            "hardware_capability": [
                1,
                2
            ]
        }
    },
    "t": 1615434898584,
    "success": true
}

错误码

参考 错误码