https://www.example.com
.
Example:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Parameter | Description |
https | The request protocol is HTTPS, and the request method is POST |
www.example.com | Callback URL |
SdkAppid | SDKAppID assigned by the Chat console when an application is created |
CallbackCommand | Fixed to Mic.CallbackAfterSeatInfoChanged |
contenttype | Fixed value: JSON |
ClientIP | Client IP, such as 127.0.0.1 |
OptPlatform | Client platform, refer to Webhook Overview: Callback Protocol for the meaning of OptPlatform parameters |
{"CallbackCommand":"Mic.CallbackAfterSeatInfoChanged","RoomId":"rid-123","SeatList":[{// Seat Number"Index": 1,// If the current microphone position is occupied, the corresponding user's ID will be returned. Otherwise, this field will not be set"Member_Account": 144115233775727695,// false: Mic access allowed true: Mic access prohibited"IsTakenDisabled": false,// false: Pushing video stream allowed true: Pushing video stream prohibited"IsVideoDisabled": false,// false: Allow audio stream push true: Prohibit audio stream push"IsAudioDisabled": false}]"EventTime":1670574414123// Millisecond level, event trigger timestamp}
Field | Type | Description |
CallbackCommand | String | Callback command |
RoomId | String | Room ID |
SeatList | Array | Microphone Position List |
Index | Integer | Microphone Position Number |
Member_Account | String | The user ID on the microphone position. If not available, this field will not be set |
IsTakenDisabled | Bool | Lock Microphone Position |
IsVideoDisabled | Bool | Prohibit microphone video stream |
IsAudioDisabled | Bool | Prohibit microphone audio stream |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // Ignore callback result}
Field | Type | Attribute | Description |
ActionStatus | String | Mandatory | The result of the request process: OK indicates success; FAIL indicates failure |
ErrorCode | Integer | Mandatory | Error Code, here 0 means to ignore the response result |
ErrorInfo | String | Mandatory | Error message |
Was this page helpful?