更新token

2023.11.17 17:58:00

    内容安全直播音频SDK监听长期房间时,可能遇到token失效导致无法继续检测,客户可通过此接口提供易盾获取最新可用的token,以完成继续检测。

    接口说明

    客户需提供获取最新有效token的api,适用于实际房间最长时长大于30天的长期房间,供易盾token失效时重新加入房间,api设计需参考易盾规范

    鉴权说明

    客户接口可以通过业务开通时易盾分配的密钥信息字段进行接口鉴权,鉴权粒度是否要精确到业务级别,用户可以根据需要自行决定,请参见接口鉴权

    接入说明

    • 协议说明:接口需要支持http协议,支持POST方法,传输数据编码采用utf-8
    • 接口性能:接口默认超时时间为2s,为了保证顺利接收数据,客户需保证接口可用性和性能稳定
    • 失败重试:客户接口处理结果数据,并返回应答。如果客户接口请求异常,超时或收到的应答不符合规范,易盾会进行重试
    • 幂等性:易盾可能会多次请求客户接口。客户接口需要保证幂等性,保证易盾能够获得最新可用的token
    • 生效方式:需要联系您的商务在您的业务上配置一个接入地址(即一个http(s)协议接口的URL)

    接口耗时

    客户接收接口需保证接收接口可用性和性能稳定,易盾请求超时时间为2s,客户接口尽量保证在1s内返回应答,如有特殊要求,可联系易盾运营适当调整超时时间

    请求

    请求地址

    名称
    HTTP URL 客户提供的更新token接口地址
    HTTP Method POST

    请求头

    名称 类型 必填 描述
    Content-Type String 固定值:"application/x-www-form-urlencoded"

    请求参数

    名称 类型 必填 最大长度 描述
    secretId String 32 产品秘钥 id ,由内容安全云服务分配,产品标识
    signature String 32 请求签名,用来验证此次请求的合法性,具体算法见接口鉴权
    url String 1024 直播提交检测时的原始url

    请求体示例

    url=***&signature=xxx&secretId=xxx
    

    响应

    响应结果

    客户接口接收到易盾的请求后,需要返回应答信息,接口响应HTTP状态码为200,当回调处理异常时,应答的HTTP状态码应为500,或者4xx; 应答信息为json格式,字段定义如下:

    名称 类型 必须返回 描述
    code Number 应答code,200表示处理成功
    msg String 具体描述信息
    result Object 当code是200时,需要返回最新可用token数据
     ∟ token String 最新可用token
     ∟ uid String 直播uid
     ∟ timestamp String 直播生成token的timestamp,注:仅在使用阿里云rtc监听时需返回

    响应体示例

    { 
        "code": 200, 
        "msg": "处理成功",
        "result": {
            "token": "******",
            "uid": "******"
        }
    }
    
    Online Chat Tel:95163223 Free trial