tencent cloud

Webhook After Room Metadata Set
Download PDF
Last updated: 2025-05-29 11:27:02
Webhook After Room Metadata Set
Last updated: 2025-05-29 11:27:02
Download PDF

Feature Description

The app server can use this webhook to monitor real-time settings of the room's metadata.

Must-Knows

To enable a webhook, you must configure the webhook URL and turn on the switch corresponding to this webhook protocol. For configuration methods, see Third-Party Webhook Configuration document.
The direction of the webhook is that the live server initiates an HTTP POST request to the app server.
After receiving the webhook request, the app server must verify whether the parameter SDKAppID in the request URL is its own SDKAppID.

Scenarios That May Trigger This Webhook

App users set metadata through the client.
App admin sets metadata via REST API.

Timing Of Webhook Occurrence

After the room metadata is set successfully.

API Description

Request URL Sample:

In the following example, the webhook URL configured for the App is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request Parameter Description

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST
www.example.com
Webhook URL
SdkAppid
SDKAppID assigned in the Chat console when creating an application
CallbackCommand
Fixed as Live.CallbackAfterSetMetadata
contenttype
The fixed value is json
ClientIP
Client IP, format: 127.0.0.1
OptPlatform
Client platform. For the value, see Introduction to Third-Party Webhooks for the parameter meaning of OptPlatform

Request Packet Sample

{
    "CallbackCommand": "Live.CallbackAfterSetMetadata",
    "Operator_Account": "brennanli",
    "RoomId": "live-room1111",
    "Metadata": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": "value2"
        }
    ],
    "EventTime": 1739965885831
}

Request Packet Field Description

Field
Type
Description
CallbackCommand
String
Webhook command.
Operator_Account
String
Operator UserID who initiates the room destruction request
RoomId
String
Room ID
Metadata
Array
Metadata data
EventTime
Integer
Millisecond-level timestamp triggered by the event
Key
String
Metadata key
Value
String
Metadata value

Response Packet Example

After the app synchronizes data in the background, it sends a webhook response packet.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore webhook result
}

Response Packet Field Description

Field
Type
Attribute
Description
ActionStatus
String
Required
The result of request processing. OK indicates successful processing, and FAIL indicates failure.
ErrorInfo
String
Required
Error message.
ErrorCode
Integer
Required
Error code, 0 means ok.

Reference

Introduction to Third-Party Webhooks
Set room's metadata
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback