You need to enable JavaScript to run this app.
导航
获取 TURN 服务信息
最近更新时间:2024.10.08 10:09:08首次发布时间:2024.05.16 14:24:27

调用此接口获取 TURN 服务信息。获取信息后,你的客户端可以借助 WTN 提供的 TURN 中继能力,提升音视频通信的成功率。
客户端如何使用此处获取的 TURN 信息,参看 使用 TURN 服务提升音视频通话的成功率

接口行为

调用此接口,请求 TURN 服务信息。

前提条件

  • 已开通 WTN 产品。参考 开通 WTN 产品
  • 已创建应用,获取 AppIDAppKey。参考 控制台
  • 已联系 WTN 技术支持人员,开通 TURN 服务。

发起请求

发起请求详细说明
请求方法GET
请求地址https://{请求域名}/turn/{AppID}
请求域名你应根据客户端所在地域,就近选择。必填。请求域名详情参看接口请求域名
路径参数 AppIDAppID 是你在控制台上创建的应用后,获取的 AppID。参与通信的多个客户端应当使用同一个 AppID
请求头Authorization:Bearer {Token},String类型。必填。要生成 Token,参考:鉴权规则
查询参数- SessionID:会话 ID,仅用于问题排查,String 类型。选填。
- TTL:Turn 服务访问凭证的过期时间,单位为秒。选填,默认值为 259200(3 天)。
如果你的 P2P 连接实际通过此处获取的 TURN 服务中转,那么,访问凭证过期后,ICE 连接会自动断开。你需要重新获取信息后,重新建立连接。

响应结果

响应头

Content-Type:"application/json"

返回参数

参数描述
codemessage参看 状态码。其中,201409 错误码在此接口的响应中不会出现。
ttl设定的访问凭证的过期时间。单位为秒,number 类型。最大值为 86400
ice_servers媒体服务连接信息,包括 TURN 信息。(实际返回值中还包含 STUN 信息。但当前不建议使用 STUN 中转。)

返回示例

请求成功时的返回示例如下:

{
    "code": 200,
    "message":"xxx", //错误描述, 非 200 时有值
    "ttl": 10800,
    "ice_servers": [
        {
            "username": "xxxxxx1",
            "credential": "yyyyyy1",
            "urls": [
                "turn:1.1.1.1:3478?transport=udp",
                "turn:1.1.1.1:3479?transport=tcp"
            ]
        }
    ]
}