logo
实时音视频
服务端 API
场景服务接口
当前页

GenerateIdentifyToken

GET

https://rtc-api.zego.im/

当您使用第三方音视频流审核服务时,您需要通过本接口生成 IdentifyToken 并将其传给审核服务提供商,以作鉴权。

目前支持的厂商包括数美、网易易盾、图谱、依图、火山引擎等厂商,完整对接流程如下:

数美

  1. 完成对接数美 智能音频流识别智能视频流识别 产品。
  2. 调用本服务端接口获取 IdentifyToken
  3. 调用数美 音频流上传请求接口视频流上传请求接口 发起请求,在请求参数中需将将 IdentifyToken 赋值给 Token

网易易盾

  1. 完成对接网易易盾 的审核功能 音视频解决方案
  2. 调用本服务端接口获取 IdentifyToken
  3. 调用网易易盾 异步检测接口 发起请求,在请求参数中需将将 IdentifyToken 赋值给 Token

图谱

  1. 完成对接图谱 的 即构语音流异步接口
  2. 调用本服务端接口获取 IdentifyToken
  3. 调用图谱 的 即构语音流异步接口 发起请求,在请求参数中需将将 IdentifyToken 赋值给 Token

依图和火山引擎

  1. 完成对接这两家服务提供商的审核功能,详情请联系服务提供商的技术支持。
  2. 调用本服务端接口获取 IdentifyToken
  3. 调用这两家服务提供商的音视频审核接口(详情请联系服务提供商的技术支持)发起请求,在请求参数中需将将 IdentifyToken 赋值给 Token
注意
  • 每个 IdentifyToken 仅能用于一次审核请求;每次调用接口开始审核前,请重新生成 1 个 IdentifyToken 使用。
  • 不同厂商在实际使用上可能有由于版本更新或其他原因与本文存在差异,建议在使用前联系技术支持确认。
调用频率限制
同一个 AppID 下所有房间:100 次/秒

Request

Query Parameters

    Action stringrequired

    Possible values: [GenerateIdentifyToken]

    接口原型参数

    https://rtc-api.zego.im?Action=GenerateIdentifyToken

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    EffectiveTime int64

    流审核鉴权 Token 的有效时长。

    单位:秒,默认为 3600 秒;最大不能超过 30 天(即取值不能超过 60 * 60 * 24 * 30)。

Responses

成功
Schema
    Code int32

    返回码。 请参考 全局返回码

    Message string

    操作结果描述

    RequestId string

    请求 ID

    Data object
    响应数据
    IdentifyToken string

    鉴权 Token

    RemainTime int64

    Token 的有效时长,指在"有效时长"范围内,可以向“数美”发起音视频流审核;审核任务开始后,正常流审核期间,不会出现审核用户掉线的问题。

    单位:秒,默认为 1 小时(3600 秒)。


Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

结束视频流审核

Next

场景模板配置

当前页

返回到顶部