please select
Features & Server APIs
  • On-Cloud Recording
  • Relay to CDN
  • RTMP Streaming with TRTC
  • Event Callbacks
    • Room&Media Callbacks
    • Relay to CDN Callback
    • Cloud Recording Callback
    • Verify Signature Example
  • Sending and Receiving Messages
  • Access Management
    • Overview
    • Manageable Resources and Actions
    • Preset Policies
    • Custom Policies
  • Enabling Advanced Permission Control
  • How to push stream to TRTC room with OBS WHIP
  • Server APIs
    • API Category
    • History
    • Making API Request
      • Request Structure
      • Common Params
      • Signature v3
      • Signature
      • Responses
    • Room Management APIs
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • Call Quality Monitoring APIs
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • Pull Stream Relay Related Interface
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • On-cloud Recording APIs
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • Stream Mixing and Relay APIs
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • Usage Statistics APIs
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • Data Types
    • Error Codes
    • Appendix
      • Event ID Mapping Table

History

Release 27

Release time: 2024-07-22 15:13:00

Release updates:

Improvement to existing documentation.

Modified APIs:

  • StartStreamIngest
    • New input parameters:StreamUrl
    • Modified input parameters: SourceUrl

Release 26

Release time: 2024-01-25 19:47:42

Release updates:

Improvement to existing documentation.

New APIs:

New data structures:

Release 25

Release time: 2023-11-24 16:25:45

Release updates:

Improvement to existing documentation.

New APIs:

New data structures:

Release 24

Release time: 2023-07-28 15:26:39

Release updates:

Improvement to existing documentation.

Modified data structures:

Release 23

Release time: 2023-05-12 11:26:05

Release updates:

Improvement to existing documentation.

New APIs:

Modified APIs:

New data structures:

Modified data structures:

Release 22

Release time: 2023-03-31 11:13:18

Release updates:

Improvement to existing documentation.

New APIs:

Release 21

Release time: 2023-03-17 11:38:29

Release updates:

Improvement to existing documentation.

New APIs:

New data structures:

Modified data structures:

Release 20

Release time: 2023-03-14 16:04:41

Release updates:

Improvement to existing documentation.

Modified data structures:

Release 19

Release time: 2023-03-02 17:29:46

Release updates:

Improvement to existing documentation.

Modified data structures:

Release 18

Release time: 2022-12-16 15:45:24

Release updates:

Improvement to existing documentation.

Modified data structures:

Release 17

Release time: 2022-11-10 16:45:18

Release updates:

Improvement to existing documentation.

New APIs:

Release 16

Release time: 2022-11-03 14:29:50

Release updates:

Improvement to existing documentation.

Modified APIs:

New data structures:

Modified data structures:

Release 15

Release time: 2022-09-20 10:16:48

Release updates:

Improvement to existing documentation.

New data structures:

Modified data structures:

Release 14

Release time: 2022-08-19 10:23:41

Release updates:

Improvement to existing documentation.

Modified APIs:

New data structures:

Modified data structures:

Release 13

Release time: 2022-07-04 11:00:48

Release updates:

Improvement to existing documentation.

New APIs:

New data structures:

Release 12

Release time: 2022-05-11 15:16:52

Release updates:

Improvement to existing documentation.

New APIs:

Deleted APIs:

  • CreatePicture
  • CreateTroubleInfo
  • DeletePicture
  • DescribeAbnormalEvent
  • DescribeCallDetail
  • DescribeDetailEvent
  • DescribeHistoryScale
  • DescribePicture
  • DescribeRecordStatistic
  • DescribeRoomInformation
  • DescribeTrtcInteractiveTime
  • DescribeTrtcMcuTranscodeTime
  • DescribeUserInformation
  • ModifyPicture
  • StartMCUMixTranscode
  • StartMCUMixTranscodeByStrRoomId
  • StopMCUMixTranscode
  • StopMCUMixTranscodeByStrRoomId

New data structures:

Deleted data structures:

  • AbnormalEvent
  • AbnormalExperience
  • EncodeParams
  • EventList
  • EventMessage
  • LayoutParams
  • OneSdkAppIdTranscodeTimeUsagesInfo
  • OneSdkAppIdUsagesInfo
  • OutputParams
  • PictureInfo
  • PresetLayoutConfig
  • PublishCdnParams
  • QualityData
  • RecordUsage
  • RoomState
  • ScaleInfomation
  • SdkAppIdRecordUsage
  • SdkAppIdTrtcMcuTranscodeTimeUsage
  • SdkAppIdTrtcUsage
  • SmallVideoLayoutParams
  • TimeValue
  • UserInformation
  • WaterMarkParams

Release 11

Release time: 2021-11-09 10:13:12

Release updates:

Improvement to existing documentation.

New APIs:

  • DescribeRecordStatistic
  • DescribeTrtcInteractiveTime
  • DescribeTrtcMcuTranscodeTime

Deleted APIs:

  • DescribeRealtimeNetwork
  • DescribeRealtimeQuality
  • DescribeRealtimeScale

New data structures:

  • OneSdkAppIdTranscodeTimeUsagesInfo
  • OneSdkAppIdUsagesInfo
  • RecordUsage
  • SdkAppIdRecordUsage
  • SdkAppIdTrtcMcuTranscodeTimeUsage
  • SdkAppIdTrtcUsage

Deleted data structures:

  • RealtimeData

Release 10

Release time: 2021-10-27 16:00:34

Release updates:

Improvement to existing documentation.

Modified data structures:

  • EncodeParams
    • New members:BackgroundImageUrl
  • WaterMarkParams
    • New members:WaterMarkUrl

Release 9

Release time: 2021-06-15 16:57:07

Release updates:

Improvement to existing documentation.

New data structures:

  • WaterMarkParams

Modified data structures:

  • LayoutParams
    • New members:WaterMarkParams

Release 8

Release time: 2021-04-28 11:08:14

Release updates:

Improvement to existing documentation.

New APIs:

  • CreatePicture
  • DeletePicture
  • DescribePicture
  • ModifyPicture

New data structures:

  • PictureInfo

Release 7

Release time: 2021-04-07 19:54:14

Release updates:

Improvement to existing documentation.

Modified data structures:

  • EncodeParams
    • New members:AudioCodec

Release 6

Release time: 2021-02-20 17:51:34

Release updates:

Improvement to existing documentation.

New APIs:

  • StartMCUMixTranscodeByStrRoomId
  • StopMCUMixTranscodeByStrRoomId

Modified data structures:

  • LayoutParams
    • New members:PureAudioHoldPlaceMode

Release 5

Release time: 2021-02-19 16:22:07

Release updates:

Improvement to existing documentation.

New APIs:

Release 4

Release time: 2021-01-21 17:40:36

Release updates:

Improvement to existing documentation.

Modified APIs:

  • StartMCUMixTranscode
    • New input parameters:PublishCdnParams

New data structures:

  • PublishCdnParams

Modified data structures:

  • LayoutParams
    • New members:PlaceHolderMode
  • PresetLayoutConfig
    • New members:MixInputType, PlaceImageId

Release 3

Release time: 2020-12-21 17:07:47

Release updates:

Improvement to existing documentation.

New APIs:

  • DescribeUserInformation

New data structures:

  • PresetLayoutConfig

Modified data structures:

  • LayoutParams
    • New members:PresetLayoutConfig

Release 2

Release time: 2020-09-25 11:41:53

Release updates:

Improvement to existing documentation.

Modified APIs:

  • DescribeCallDetail
    • New input parameters:PageNumber, PageSize

Modified data structures:

  • LayoutParams
    • New members:MixVideoUids

Existing Release

Release time: 2020-07-30 20:35:23

Existing APIs/data structures are as follows:

Improvement to existing documentation.

Existing APIs:

  • CreateTroubleInfo
  • DescribeAbnormalEvent
  • DescribeCallDetail
  • DescribeDetailEvent
  • DescribeHistoryScale
  • DescribeRealtimeNetwork
  • DescribeRealtimeQuality
  • DescribeRealtimeScale
  • DescribeRoomInformation
  • DismissRoom
  • RemoveUser
  • StartMCUMixTranscode
  • StopMCUMixTranscode

Existing data structures: