tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Callback for Room Member Status Change

    Last updated: 2024-09-24 15:07:19
    Download PDF

      Feature Overview

      The app backend can view users' online and offline status changes in the room in real time through this callback.

      Notes

      To enable this callback, you must configure the callback URL and toggle on the corresponding protocol. For more information on the configuration method, see Third party callback configuration documentation.
      During this callback, the Live backend initiates an HTTP POST request to the app backend.
      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 that may trigger this callback

      App users successfully create a room through the client
      App administrators successfully create a room via the REST API

      Callback Trigger Time

      After the room is created successfully.

      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
      SDKAppID assigned by the Instant Messaging console when an application is created
      CallbackCommand
      Fixed as Live.CallbackMemberStateChanged
      contenttype
      Fixed value: JSON

      Sample request packets

      {
          "CallbackCommand":"Live.CallbackAfterMemberStateChanged",
          "RoomId":"room_id",
          "EventType":"Online", // Online or Offline
          "EventCause":"Enter", // Four types: Enter (enter room), Leave (leave room), HeartbeatInterrupt, HeartbeatRecover
          "MemberList":[
              {
                  "Member_Account": "jared"
              },
              {
                  "Member_Account": "tommy"
              }
          ],
          "EventTime":1703589922780
      }

      Request packet fields

      Field
      Type
      Description
      CallbackCommand
      String
      Callback command
      RoomId
      String
      Room ID
      EventType
      String
      Event type: divided into two types, user online and offline, Online, Offline
      EventCause
      String
      Event Cause, divided into the following four types: Enter (enter room), Leave (check-out), HeartbeatInterrupt, HeartbeatRecover
      MemberList
      Array
      Involved Member List
      EventTime
      Interger
      Event trigger timestamp in milliseconds

      Response packet example

      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 indicates success; FAIL indicates failure
      ErrorCode
      Integer
      Mandatory
      Error Code, here 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