GenerateIdentifyToken
https://rtc-api.zego.im/
When you use third-party audio/video stream moderation services, you need to use this API to generate an IdentifyToken and pass it to the moderation service provider for authentication.
Currently supported vendors include ShuMei, NetEase Yidun, TuPu, YiTu, and Volcengine. The complete integration process is as follows:
ShuMei
- Complete the integration with ShuMei's Intelligent Audio Stream Recognition and Intelligent Video Stream Recognition products.
- Call this server API to obtain the
IdentifyToken. - Call ShuMei's Audio Stream Upload Request API or Video Stream Upload Request API to initiate a request, and assign the
IdentifyTokento theTokenparameter in the request.
NetEase Yidun
- Complete the integration with NetEase Yidun's moderation functionality Audio/Video Solution.
- Call this server API to obtain the
IdentifyToken. - Call NetEase Yidun's Async Detection API to initiate a request, and assign the
IdentifyTokento theTokenparameter in the request.
TuPu
- Complete the integration with TuPu's ZEGO Audio Stream Async API.
- Call this server API to obtain the
IdentifyToken. - Call TuPu's ZEGO Audio Stream Async API to initiate a request, and assign the
IdentifyTokento theTokenparameter in the request.
YiTu and Volcengine
- Complete the integration with these two service providers' moderation functionality. For details, please contact the service provider's technical support.
- Call this server API to obtain the
IdentifyToken. - Call these two service providers' audio/video moderation APIs (for details, please contact the service provider's technical support) to initiate a request, and assign the
IdentifyTokento theTokenparameter in the request.
- Each
IdentifyTokencan only be used for one moderation request. Before starting each moderation, please regenerate oneIdentifyTokento use. - Different vendors may have differences from this document due to version updates or other reasons in actual use. It is recommended to confirm with technical support before use.
Request
Query Parameters
Possible values: [GenerateIdentifyToken]
API prototype parameters
https://rtc-api.zego.im?Action=GenerateIdentifyToken
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Common parameter. A 16-character hexadecimal random string (hex-encoded 8-byte random number). For the generation algorithm, refer to the signature example.
💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to the signature example. A maximum deviation of 10 minutes is allowed.
💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to the signature mechanism to generate it.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
The validity period of the stream moderation authentication Token.
Unit: seconds, default is 3600 seconds; maximum cannot exceed 30 days (i.e., the value cannot exceed 60 * 60 * 24 * 30).
Responses
- 200
- application/json
