Feedback and Report Callback Notification
Updated: 2023-02-13 11:33:08
Purpose
Using this feature, after a user submits feedback or a report, the server will send a notification via POST to the custom callback URL set by the client.
Timeout and Retry
- If the callback server does not receive a response from your server within 5 seconds after sending the notification, it is considered a failure. Subsequent failures will be retried twice at 5-second intervals.
- The interface returns a JSON object. If the callback does not return a 200 status, it will be retried twice. After more than 2 retries, the log is discarded.
Callback Message Format
Event callback messages are sent to your server via HTTP/HTTPS POST requests, where:
- Character encoding format: UTF-8.
- Request: The body format is JSON.
- Response requirement: The response header must specify
Content-Type: application/json. - Correct response: HTTP status code 200 indicates successful reception and processing. Any other status is considered a failure and will be retried.
Callback Parameter Description
| Parameter | Type and Range | Description |
|---|---|---|
| userId | string | Live streaming account ID |
| channelId | string | Channel ID |
| channelName | string | Channel name |
| viewerId | string | Viewer ID |
| viewerName | string | Viewer nickname |
| createdTime | string | Creation time (format: yyyyMMddHHmmss) |
| type | string | Type complaint: Report suggestion: Feedback |
| label | string | Report category porn: Pornography and vulgarity bloody: Horror and gore scam: Fraudulent information uncivilized: Indecent speech illegal-entry: Unauthorized entry infringe-right: Rights infringement other-violations: Other reports Feedback category stuck: Page lag black-screen: Black screen slow-access: Slow access poor-experience: Poor experience play-suggestion: Gameplay suggestions other-feedback: Other feedback |
| content | string | Content |
| imageUrls | array | Image URLs |
| contact | string | Contact information |
| actor | string | Presenter title |
| teacherName | string | Presenter nickname |
Callback Data Example
Response body:
{
"userId": "43231hnaa2",
"channelId": 2191532,
"channelName": "测试",
"viewerId": "1676254629615",
"createdTime": "20230213112103",
"type": "suggestion",
"label": "stuck",
"content": "123123",
"imageUrls": ["http://liveimages.videocc.net/watch-feedback/43f5f9caa2/3757791/1676258463568_37rXln.jpeg"],
"contact": "",
"actor": "讲师",
"teacherName": "讲师"
}
How to Configure
Configure via the backend:
Log in to your account - Go to [Cloud Live] - Click [Development Settings] - Click [Callback Settings] - One-click report callback for live rooms
Note: The submitted interface URL must start with http:// or https://
