tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Interactive Whiteboard
    Documentation

    Whiteboard Push Event

    Last updated: 2023-12-21 10:52:28

      Whiteboard Push Initiation

      Event Name
      WhiteboardPushStarted
      Event Description
      The application background will receive a notification when the whiteboard push service is ready and begins pushing.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the whiteboard push task that has started
      RoomId
      Integer
      Room ID of the whiteboard
      PushUserId
      String
      User ID for the user who enters the room through the whiteboard push service in the current task
      PushStartTime
      Integer
      Actual start time of the pushing (a Unix timestamp in seconds)
      Example
      {
          "EventData": {
              "PushStartTime": 1610545438,
              "PushUserId": "tic_push_user_1253_01",
              "RoomId": 1253,
              "TaskId": "bj0mt2l23osdj300hl30"
          },
          "EventType": "WhiteboardPushStarted",
          "ExpireTime": 1590046391,
          "SdkAppId": 1400000001,
          "Sign": "a2dabb362a9b811c0e26953a6276a41c",
          "Timestamp": 1575545412
      }

      Whiteboard Push Termination

      Event Name
      WhiteboardPushStopped
      Event Description
      The application background will receive a notification when the user actively calls the whiteboard push stop interface or the whiteboard push is automatically stopped due to other reasons.
      EventData Data Structure Definition
      Parameter Name
      Type
      Description
      TaskId
      String
      Task ID of the terminated whiteboard push task
      RoomId
      Integer
      Room ID
      GroupId
      String
      Group ID of the whiteboard
      PushUserId
      String
      Push User ID
      FinishReason
      String
      Reasons for push termination
      AUTO: the pushing automatically stopped when there were no audio and video data flow and whiteboard operations in a room for a long time
      USER_CALL: push termination triggered by an active call to end the push interface
      EXCEPTION: push termination due to an anomaly
      PushStartTime
      Integer
      Actual start time of the pushing (a Unix timestamp in seconds)
      PushStopTime
      Integer
      Actual stop time of the pushing (a Unix timestamp in seconds)
      IMSyncTime
      Integer
      The corresponding IM timestamp of whiteboard push's first frame. It is used for recording a time synchronization between IM chat messages and whiteboard push video when plays back.
      ExceptionCnt
      Integer
      Number of anomalies occurred in the push process
      Error.Code
      String
      This field will exist if an error occurs in the whiteboard push, and the error code is FailedOperation.Record.
      Error.Message
      String
      Specific error descriptions for errors if occur in the whiteboard push
      Example
      {
        "EventData": {
          "TaskId": "ghucnligqtgtvk2624mb",
          "RoomId": 880528,
          "GroupId": "880528",
          "PushUserId": "tic_push_user_880528_test-01",
          "FinishReason": "USER_CALL",
          "PushStartTime": 1568949369,
          "PushStopTime": 1568949392,
          "IMSyncTime": 1568949369,
          "ExceptionCnt": 0
        },
        "EventType": "WhiteboardPushStopped",
        "ExpireTime": 1590046391,
        "SdkAppId": 1400000001,
        "Sign": "a2dabb362a9b811c0e26953a6276a41c",
        "Timestamp": 1575545412
      }
      
      
      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