Release Notes

Product Introduction

Overview

Strengths

Features

Scenarios

Compliance

User Tutorial

Billing

Free Plan

Purchase Guide

SDK Download Guide

Product Feature Demo

Basic Feature Demo

Scenario-Specific Demo

Console Guide

Usage Querying

Activating Services

Getting Started

Quick Integration of SDK

Quick Integration of Sample Project

Basic Feature Development Guide

Authentication Key

Voice Chat Role Configuration

Sound Quality

Advanced Feature Development Guide

Server-Side Recording

Range Voice

3D Sound Effect

Sound Effect and Accompaniment

Network Audio Stream Forwarding Routing

Custom Message Channel

How to deal with the restrictions of corporate firewall

Language Parameter Reference List

Integrating GME Chat Room Management

Client API

SDK for Unity

SDK for Unreal Engine

Cocos2D SDK

SDK for Windows

SDK for iOS

SDK for Android

SDK for macOS

H5 SDK

Electron SDK

SDK for Flutter

SDK Version Upgrade Guide

Error Codes

Toolchain

Server APIs

History

Introduction

API Category

Usage APIs

Recording APIs

Making API Requests

Voice Chat APIs

Application APIs

Data Types

Error Codes

FAQ

Product Features

Troubleshooting Guide

Billing

Sample Project Usage

General

Authentication

Voice Chat Room Entry Failure

Sound and Audio

Network

Speech-to-text Conversion

Program Export

Service Agreement

Service Level Agreement

Glossary

GME Policy

Data Privacy and Security Agreement

Recording Callback Description

PDF

Focus Mode

Font Size

Last updated: 2025-08-26 15:58:58

Description of the Server-Side Recording Callback
Notes
Subject to the network conditions, the sequence of the notifications received by your server may be different from the sequence of the events that actually occurred.The service offers a retry mechanism, but it is not guaranteed that all messages can arrive.In view of the above, it is not recommended that your core business logic depend on the message notification service.
Network protocol
If the callback URL, i.e., the URL of an HTTP(S) API, is configured in the console, then the POST method should be supported and transferred data should be encoded with UTF-8.
HTTP header parameters
Parameter
Type
Required
Description
Signature
String
Yes
Signature. For more information, see Signature generation.
Signature generation
Signature = HMAC-SH1 ( strContent, SecretKey )
strContent: Original signature string, which is the entire JSON content of body (the length is subject to Content-Length).
body: JSON content called back to the business. The entire content in Sample callback is body.
SecretKey: Application permission key, which can be viewed in Details in the console.
HMAC-SH1: Signature algorithm.
Callback parameters
Name
Type
Description
BizID
Integer
Application's `AppID`, which can be viewed in Details in the console.
RoomID
String
Room ID
UserID
String
User ID
RecordMode
Integer
Recording mode. Valid values:
0: Single stream    
1: Mixed stream
Timestamp
Integer
Timestamp in seconds when the callback is sent
TaskID
Integer
The task ID assigned by the cloud recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends. When you use the custom recording mode, the task ID can be obtained through the response parameter when recording starts. It needs to be saved by the business as a request parameter for subsequent operations on the recording task.
EventType
Integer
Event type
Detail
﻿EventDetail﻿
Event details, whose format is specified by EventType.
EventDetail event details
EventType
Description
Detail
1
Recording started.
SeqNo: Segment number of the Number type
FileName: Filename of the String type
2
Recording is completed.
SeqNo: Segment number of the Number type
FileName: Filename of the String type
3
The audio file has been uploaded.
SeqNo: Segment number of the Number type
FileName: Filename of the String type
Sample callback
{
    "BizID":1400000000,
    "RoomID":"100",
    "UserID":"999",
    "TaskID":446946705284000000,
    "RecordMode":1,
    "Timestamp":1675930605,
    "EventType":1,
    "Detail":{
        "SeqNo":0,
        "FileName":"1400000000_100_999/2023-02-09-16-16-45_446946705284000000_audio.mp3"
    }
}
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Game Multimedia Engine

Recording Callback Description

Description of the Server-Side Recording Callback

Notes

Network protocol

HTTP header parameters

Signature generation

Callback parameters

`EventDetail` event details

Sample callback

Help and Support

Parameter	Type	Required	Description
Signature	String	Yes	Signature. For more information, see Signature generation.

Name	Type	Description
BizID	Integer	Application's `AppID`, which can be viewed in Details in the console.
RoomID	String	Room ID
UserID	String	User ID
RecordMode	Integer	Recording mode. Valid values: 0: Single stream 1: Mixed stream
Timestamp	Integer	Timestamp in seconds when the callback is sent
TaskID	Integer	The task ID assigned by the cloud recording service, which uniquely identifies a recording process and becomes invalid after a recording task ends. When you use the custom recording mode, the task ID can be obtained through the response parameter when recording starts. It needs to be saved by the business as a request parameter for subsequent operations on the recording task.
EventType	Integer	Event type
Detail	EventDetail	Event details, whose format is specified by EventType.