End Recording Group Information Callback Notification
Updated: 2022-07-28 15:29:11
Purpose
When this feature is enabled, after a group finishes recording, the server will send a notification to the callback URL set by the customer via a POST request to the user-defined callback interface.
Parameters included in the callback (sent as form-data parameters):
| Parameter | Type | Description |
|---|---|---|
| logList | string | Array of logList objects |
| timestamp | number | Current timestamp |
logList Object Array Format
| Parameter | Type | Description |
|---|---|---|
| channelId | string | Channel ID |
| channelName | string | Channel name |
| groupId | string | Group ID |
| groupName | string | Group name |
| endTime | Long | Timestamp when recording ended, in 13-digit format |
| fileId | string | Recording file ID |
| fileName | string | Recording file name |
| videoUrl | string | Recording video URL |
| content | string | OSS URL for the student list; retrieve student list info from this URL. Refer to the content OSS URL JSON object format for the returned data format. |
Note
- The interface returns a JSON object. If the callback does not return a 200 status, it will retry 3 times. After 3 failed attempts, the log is discarded.
Content OSS URL JSON Object Format
| Parameter | Type | Description |
|---|---|---|
| logs | Array | Array of logs objects |
Logs Object Array Format
| Parameter | Type | Description |
|---|---|---|
| channelId | string | Channel ID |
| groupId | string | Group ID |
| groupName | string | Group name |
| viewerId | string | Participant ID |
| permission | string | User role (optional). When a group is disbanded, the leader field is not returned in permission. When recording ends due to live stream termination, permission is not sent. host: Host viceHost: Co-host leader: Group leader. Group members do not send this field. |
| nickName | string | User nickname |
| logTime | number | Log timestamp |
| role | string | User identity: teacher: Instructor, guest: Guest, viewer: Audience, assistant: Teaching assistant, attendee: Host or participant in webinar scenarios, listener: Audience in webinar scenarios |
How to Configure
Configure via the backend:
Log in to your account - Go to [Cloud Live] - Click [Development Settings] - Click [Callback Settings] - End Recording Returns Group Information
Note: The submitted callback URL must start with http:// or https://.
