Create RTMP URL for event

Create Real-Time Messaging Protocol with their details for event video streaming. API can be use by host level user's permission to access this API which contains admin, staff and super admin. User need to pass an authentication token as header, session ID as path parameters and regenerate as query parameter.

Here is the description of response attributes, which returns to the form of JSON.

Attribute

Description

streamProvider

It's contains the Stream Provider Name Of session. Session contains ACCELEVENTS, WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD stream provider.

subStreamProvider

It's contains the Sub Stream Provider Name Of session. Session contains VOXEET,CHIME,OPENTOK,AGORA sub stream provider.

streamUrl

It contains streaming URL. For WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD need to set streaming URL for ACCELEVENTS it will generate unique streaming UR.

streamKey

It's contain unique stream key.

rtmpUrl

It's contain RTMP URL. It will use to put in OBS studio with stream key.

accelEventsStudio

It returns true if stream provider is ACCELEVENTS else false.

playBackRestrictionToken

It's contains playback restriction token, which is allows you to set additional rules for playing videos. For instance, viewers can play videos embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any Video requests from other websites are denied.

thumbnailRestrictionToken

It's contains playback restriction token, which is allows you to set additional rules for thumbnails. For instance, viewers can view thumbnails embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any thumbnails request from other websites are denied.

metaData

Details of created stream key details in JSON. Which is generated after creating stream key.

liveStreamId

The live stream ID.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4030201

Not Event Host

4068912

Can not generate stream key, live stream in process.

404800

Session not found!

4044005

Mux live stream status not available.

4044004

Mux live stream can not create.

Language
Authentication
Header
Click Try It! to start a request and see the response here!