tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    After a Room Is Left

    Last updated: 2024-06-12 11:46:26
    Download PDF

      Feature Overview

      The App backend can view the messages of room members leaving in real-time through this callback, including: notifying the app backend that a member has left the room, allowing the app to perform necessary data synchronization.

      Notes

      To enable the callback, a callback URL must be configured and the switch corresponding to this callback protocol activated. For configuration methods, see Third-party Callback Configuration document.
      The direction of the callback is from the Room backend to the App backend via an HTTP POST request.
      After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.

      Scenarios

      App users actively leave the room through the client.
      App users are kicked out of the room.
      App users are forced to leave the room due to heartbeat expiration.

      Callback Trigger Time

      After users successfully leave the room.

      API Description

      Sample Request URL

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

      Request Parameters

      Parameter
      Description
      https
      The request protocol is HTTPS, and the request method is POST
      www.example.com
      Callback URL
      SdkAppid
      The SDKAppID assigned by the Chat console when an application is created
      CallbackCommand
      Fixed as Room.CallbackAfterMemberLeave
      contenttype
      Fixed value: JSON
      ClientIP
      Client IP, format such as 127.0.0.1
      OptPlatform
      Client platform. For the value, refer to the meaning of the OptPlatform parameter of Webhook Overview: Callback Protocol.

      Sample Request Packets

      {
        "CallbackCommand":"Room.CallbackAfterMemberLeave",
        "Operator_Account":"user1",
        "RoomId":"rid-123",
        "MemberCount":20,
      
        "Type":"Leave", 
        "MemberList_Account":["user1"],
        "Reason":"xxxx",
        "EventTime":1670574414123// Millisecond level, event trigger timestamp
      }

      Request Packet Field Description

      Field
      Type
      Description
      CallbackCommand
      String
      Callback command
      Operator_Account
      String
      UserID of the requester
      RoomId
      String
      Room ID
      MemberCount
      Integer
      Room capacity
      Type
      String
      Check-out method: Leave (self left); Kicked (kicked out); Expired (heartbeat expired)
      MemberList_Account
      Array
      Exit room member list
      Reason
      String
      Reason for check-out
      EventTime
      Integer
      Event trigger timestamp in milliseconds

      Sample Response Packets

      A callback response packet is sent after the app backend synchronizes the data.
      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0 // Ignore callback result
      }

      Response Packet Field Description

      Field
      Type
      Attribute
      Description
      ActionStatus
      String
      Mandatory
      The result of the request process. OK for success, FAIL for failure.
      ErrorCode
      Integer
      Mandatory
      Error code, 0 means to ignore the response result
      ErrorInfo
      String
      Mandatory
      Error message

      Reference

      Webhook Overview
      
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy