推送模式

2024.05.30 10:42:32

    直播账号名单推送模式用于将直播账号主动推送给客户,保证客户最快的获取直播账号最新状态。客户需要按照以下规范实现接收结果的接口。推送模式与轮询模式互斥,只能选取一种模式进行结果获取。

    接口说明

    主动推送模式以数据为维度,将直播账户名单推送给客户,如需开启推送模式,可联系易盾运营人员调整配置。客户方需保证回调接收接口的可用性和稳定性,确保能正常接收推送过来的直播账号名单数据。

    鉴权说明

    客户接口可以通过业务开通时易盾分配的密钥信息字段进行接口鉴权,请参见接口鉴权

    接入说明

    • 协议说明:直播音视频账号主动推送接口需要支持http协议,支持POST方法,传输数据编码采用utf-8
    • 接口性能:推送结果接口默认超时时间为2s,为了保证顺利接收数据,客户需保证接收接口可用性和性能稳定
    • 失败重试:客户接口处理结果数据,并返回应答。如果客户接口请求异常,超时或收到的应答不符合规范,易盾会认为推送失败;我们将每隔1分钟推送一次,如果一直失败,持续7天后不再推送
    • 幂等性:结果推送时同样的结果可能会多次请求客户接口,客户接口需要保证幂等性,能够正确处理重复结果数据

    接口耗时

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

    请求

    请求地址

    名称 描述值
    HTTP URL 直播名单回调地址
    HTTP Method POST

    请求头

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

    请求参数

    参数名称 类型 是否必选 最大长度 描述
    secretId String 32 产品秘钥 id ,由易盾内容安全云服务分配,产品标识
    signature String 32 请求签名,用来验证此次请求的合法性
    callbackData String - 主动推送结果数据,格式为 json 字符串,字段描述请参考轮询模式回调参数说明

    请求体示例

    secretId=xxx&callbackData=***&signature=xxx
    
    • 请求体 callbackData 格式如下,callbackData 为 JSON 字符串格式,请自行解析或者反转成 JSON 对象使用。
    • callbackData 各字段意义如下表:
    参数名称 类型 必须返回 描述
    account String 主播账号,名单类型为禁言时返回的是声网/云信的uid
    type Number 名单类型 0-隐藏名单 1-禁播名单 2-重点关注名单 3-安全主播名单 4-禁言名单 8-仅下画面用户名单 5-房间禁播名单
    releaseTime Number 名单自动失效时间, 0代表不自动失效
    spamType Number 违规类型 100-色情 200-广告 300-暴恐 400-违禁 500-涉政 800-不文明 1000-其他
    spamLabel Number 违规分类标签:
    隐藏名单分类标签——1-不符合运营需求 3-扰乱房间秩序 4-封面违规 5-即将违规 6-不优质 7-违规处罚
    禁播名单分类标签——101-涉黄言论 102-低俗信息 103-垃圾广告 104-违禁内容 105-涉政内容 106-不文明行为 107-扰乱房间秩序 108-不符合平台运营要求
    禁言名单分类标签——同禁播名单分类标签
    仅下画面名单分类标签——同禁播名单分类标签
    重点关注名单分类标签——201-重点关注
    安全主播名单分类标签——301-安全主播
    spamDetail String 违规详情
    status Number 名单状态 0-失效 1-生效
    roomNo String 房间号
    taskId String 直播taskId
    actionTime Number 操作时间
    transformAccount String 接入主播账号转换接口规范后返回的原主播账号
    callback String 提交时传递的callback
    dimensionType Number 名单维度:主播名单-0,房间内用户名单-1,房间名单-2
    • 返回 callbackData JSON串格式如下:
    {
        "account":"10307929",
        "type":0,
        "releaseTime":0,
        "spamType":100,
        "spamLabel":1,
        "spamDetail":"不符合运营需求",
        "status":1,
        "roomNo":"Room21345",
        "taskId":"de3ccb2e361e44b6a58d71fdd0e721ec",
        "actionTime":0,
        "transformAccount":"",
        "dimensionType":0
    }
    

    响应

    响应结果

    客户端接口接收到推送的结果后,需要返回应答信息。接口响应的HTTP状态码为200,当回调处理异常时,应答的HTTP状态码应为500或4xx。应答信息为JSON格式,字段定义如下:

    名称 类型 必须返回 描述
    code Number 应答code,易盾方解析code为200表示推送成功
    msg String 具体描述信息

    响应体示例

    { 
        "code": 200, 
        "msg": "ok"
    }
    
    Online Chat Tel:95163223 Free trial