Release Notes

This Changelog highlights notable changes to the 100ms server-side API, such as API additions, improvements, and deprecations. Also, we've included developer experience improvements to this page to keep you on track with items that will enhance your integration journey.

2024-02-28

Additions

• Added new recording APIs to provide configurations for different kind of recordings - trackRecording, streamRecording, compositeRecording
• Added new asset types - track and stream in recording assets API.
• Added following new webhook events -
  1. track.recording.started.success
  2. track.recording.success
  3. track.recording.failure
  4. stream.recording.success
  5. stream.recording.failure

Deprecations

• The settings.enabled field in template API which was used to enable custom composite recording, has been deprecated. Please use the new recordings API to configure composite recordings.
• The destinations.browserRecordings field in template API which was used to provide configuration for browser based recording, has been deprecated. Please use the new recordings API to configure browser recording.

2024-02-27

• Added support for SIP Interconnect. Only available in preview access.

2023-12-20

• Added support for pause and resume recording.

2023-11-22

• Added support for Polls APIs.

2023-11-15

• Added support for transcription for live stream viewers in Start live stream API and Policy APIs.
• Post Call Transcription now supports HLS Recording as well details of which are updated here.

2023-10-31

• Added support for setting max_duration_seconds in Room API.
  • This defines a maximum session duration, ensuring that the session automatically ends after the specified time limit is reached.

2023-10-24

• Added new field autoStopTimeout in destinations objects in template

2023-10-17

• Added support for RTMP ingestion to live stream on 100ms from a RTMP broadcaster. Added documentation for:
  • Create RTMP stream key for a specific room
  • Get RTMP stream key and URL for a specific room
  • Disable RTMP stream key for a specific room
  • Webhook events for RTMP ingestion

2023-10-11

• Added support for large room creation through the Room API. Learn more about it in this guide.

2023-08-01

• Added Optimisations to reduce RTMP streaming and recording start delay

2023-07-25

• Added support for pollRead and pollWrite in template permissions.

2023-07-07

Addition

• Added support for transcriptions destination in template APIs
• Added transcription support in start recording API
• Introduced new recording assets types transcript and summary for speaker labelled transcript and AI-generated summary respectively

2023-07-04

Addition

• Added reserved IP's of production turn load balancer of EU|US|IN.

2023-05-11

Addition

• Added reserved turn IP of production TURN servers.

Removed

• Segregated the production turn IP's from NAT IP

2023-04-28

Additions

• Added reserved IP for production turn servers of EU|US|IN. When end user's is unable to join room or when join room is working but user is getting kicked out of room. This issues might be related to user's firewall blocking connection.In such scenarios end user needs to whitelist IP in the firewall for the 100ms call to work.

2023-04-28

Additions

• Added reserved IP addresses for TURN servers in EU|US|IN. These IP addresses can be whitelisted in firewall configuration to solve scenarios where a user is unable to join the room due to a restricted network firewall.

2023-04-11

Additions

• Added guide for Server-side Node.js SDK

2023-03-22

Additions

• Added new APIs to start, stop and manage Live Streams and External Streams
• Added new APIs to generate pre-signed URLs for Recording Assets

2023-03-10

Additions

• Added chat_recording_path and chat_recording_presigned_url to recording completion webhooks across browser recording (beam.recording.success), SFU recording (recording.success), and HLS VOD recordings (hls.recording.success)

2023-03-07

Additions

• Added Analytics APIs with support for fetching Track events

2023-02-23

Additions

• Added APIs for retrieving and updating template's destinations.

2023-02-16

Additions

• Added error_type field in recording.failed webhook.

Improvements

• Standardised error field in recording.failed webhook.

2023-01-31

Additions

• Added List Peers API to Active room APIs that enables listing peers in a room with filtering support for user_id, role fields

2023-01-23

Additions

• Added role_change_requested_by field in role.change.success and role.change.failure webhooks.

2023-01-13

Additions

• Added support to Google cloud - gs and Alibaba Cloud - oss. Check recording config for Create a room API and Create a template API for more information.

2023-01-11

Additions

• Added a new IP address for whitelisting 129.154.236.15/32. Check IP whitelisting for more information.

2023-01-04

Additions

• Added user_id field in Sessions object.

Deprecations

• Deprecated user field in Sessions object. user_id can be used instead of user.

2022-12-29

Improvements

• Standardised error_type, error_message fields in beam.failure and hls.failure webhooks.

Deprecations

• Deprecated state_name, state_message, and state_timestamp fields from since they do not add any value. timestamp can be used instead of state_timestamp.
• Deprecated error_code. This has always been 1 and does not have any significance.

2022-11-23

Additions

• Added a new event role.change.failure to notify role change failures.

2022-11-18

Additions

• Added new fields in HLS, beam, recording, role change, peer leave and session close webhook events.

2022-11-03

Additions

• Added support for securing webhooks by whitelisting 100ms NAT gateway IP addresses.
• Added new fields in Beam events: recording_enabled, max_width, and max_height
• Added new fields in HLS events: recording_single_file_per_layer_enabled and recording_vod_playlist_enabled
• Added hlsDestination response object in retrieve a specific template API

Developer experience

• Documentation improvements in webhooks guide -- merged description and example columns to provide better readability.

2022-10-06

Additions

• A new set of Active room APIs enables you to remotely control your active rooms by performing actions such as retrieving details of an active session, retrieving/updating peer information, sending messages, removing peers, and ending an active session.

Developer experience

• Simplified generation of management token within Postman collection -- we've added a pre-request script in our collection to help you generate the management token without creating a token management service at your end for testing. Refer to the Postman guide for more details.
• As environment variables created some confusion, we've removed the environment from our Postman collection. We recommend you use the collection variables going forward. Refer to the Postman guide for more details.
• Added the API reference documentation for legacy APIs(V1).

Deprecations

• Removed active field from room object as enabled field was already available to indicate whether the room is in enabled or disabled state.

2022-09-24

Server update

• The API is now available in the production environment, using the following base URL: https://api.100ms.live/v2/

Additions

• A new set of Room APIs
• A new set of Session APIs
• A new set of Policy APIs
• Destinations object is added to the template object.

API Improvements

• RESTful adherence - params are now URL params and not query params.
• Extended pagination for all endpoints -- We paginate the responses with a list of objects ranging from 10 to 100 to ensure they are easier to handle.

Developer experience

• Virtual controlled Postman collection -- you can fork our Postman collection to stay up to date with the latest API improvements. This will enable you to get familiar with and interact more seamlessly with our product.
• Detailed API reference -- We have improved our documentation, so it's easier to get started and stay up to date with the latest API improvements.

Deprecations

• In the template object, the fields _id, and customer, supported with the Legacy API (V1), is deprecated. You can continue to use them as id and customer_id with the new API. Refer to the template object section for more information.
• In the room object, the field template supported with the template name in the Legacy API (V1) will not be supported in the new API. Instead, you can use the template_id field.