Rest API

• health
  • getDescribes the health of Fishjam
• hls
  • getRetrieve HLS Content
• recording
  • getLists all available recordings
  • delDeletes the recording
  • getRetrieve Recording (HLS) Content
• room
  • getShow information about all rooms
  • postCreates a room
  • delDelete the room
  • getShows information about the room
  • postCreates the component and adds it to the room
  • postSubscribe component to the tracks of peers or components
  • delDelete the component from the room
  • postCreate peer
  • delDelete peer
• sip
  • delFinish call made by SIP component
  • postMake a call from the SIP component to the provided phone number

API docs by Redocly

Fishjam Media Server (0.6.3)

Download OpenAPI specification:Download

License: Apache 2.0

health

Describes the health of Fishjam

Authorizations:

authorization

Responses

https://raw.githubusercontent.com/health

Response samples

• 200
• 401

Content type

application/json

{

• "data": {

  • "distribution": {

    • "enabled": true,
    • "nodeStatus": "UP",
    • "nodesInCluster": 0

    },
  • "gitCommit": "string",
  • "status": "UP",
  • "uptime": 0,
  • "version": "string"

  }

}

hls

Retrieve HLS Content

path Parameters

room_id required	string Room id
filename required	string Name of the file

query Parameters

_HLS_msn	integer or null (HlsMsn) >= 0 Example: _HLS_msn=10 Segment sequence number
_HLS_part	integer or null (HlsPart) >= 0 Example: _HLS_part=10 Partial segment sequence number
_HLS_skip	string or null (HlsSkip) Example: _HLS_skip=YES Is delta manifest requested

header Parameters

range

string Byte range of partial segment

Responses

https://raw.githubusercontent.com/hls/{room_id}/{filename}

Response samples

• 200
• 400
• 404
• 503

Content type

application/json

"string"

recording

Lists all available recordings

Authorizations:

authorization

Responses

https://raw.githubusercontent.com/recording

Response samples

• 200
• 401
• 404

Content type

application/json

{

• "data": [

  • "string"

  ]

}

Deletes the recording

Authorizations:

authorization

path Parameters

recording_id required

string Recording id

Responses

https://raw.githubusercontent.com/recording/{recording_id}

Response samples

• 400
• 401
• 404

Content type

application/json

{

• "errors": "Token has expired"

}

Retrieve Recording (HLS) Content

path Parameters

recording_id required	string Recording id
filename required	string Name of the file

Responses

https://raw.githubusercontent.com/recording/{recording_id}/{filename}

Response samples

• 200
• 400
• 404

Content type

application/json

"string"

room

Show information about all rooms

Authorizations:

authorization

Responses

https://raw.githubusercontent.com/room

Response samples

• 200
• 401

Content type

application/json

{

• "data": [

  • {

    • "components": [

      • {

        • "id": "component-1",
        • "properties": {

          • "lowLatency": true,
          • "persistent": true,
          • "playable": true,
          • "subscribeMode": "auto",
          • "targetWindowDuration": 0

          },
        • "tracks": [

          • {

            • "id": "string",
            • "metadata": null,
            • "type": "audio"

            }

          ],
        • "type": "hls"

        }

      ],
    • "config": {

      • "maxPeers": 10,
      • "peerDisconnectedTimeout": 60,
      • "peerlessPurgeTimeout": 60,
      • "roomId": "string",
      • "videoCodec": "h264",
      • "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"

      },
    • "id": "room-1",
    • "peers": [

      • {

        • "id": "peer-1",
        • "metadata": {

          • "name": "FishjamUser"

          },
        • "status": "disconnected",
        • "tracks": [

          • {

            • "id": "string",
            • "metadata": null,
            • "type": "audio"

            }

          ],
        • "type": "webrtc"

        }

      ]

    }

  ]

}

Creates a room

Authorizations:

authorization

Request Body schema: application/json

optional

Room configuration

maxPeers	integer or null >= 1 Maximum amount of peers allowed into the room
peerDisconnectedTimeout	integer or null >= 1 Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
peerlessPurgeTimeout	integer or null >= 1 Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
roomId	string or null Custom id used for identifying room within Fishjam. Must be unique across all rooms. If not provided, random UUID is generated.
videoCodec	string or null Enum: "h264" "vp8" Enforces video codec for each peer in the room
webhookUrl	string or null URL where Fishjam notifications will be sent

Responses

https://raw.githubusercontent.com/room

Request samples

• Payload

Content type

application/json

{

• "maxPeers": 10,
• "peerDisconnectedTimeout": 60,
• "peerlessPurgeTimeout": 60,
• "roomId": "string",
• "videoCodec": "h264",
• "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"

}

Response samples

• 201
• 400
• 401
• 503

Content type

application/json

{

• "data": {

  • "fishjam_address": "fishjam1:5003",
  • "room": {

    • "components": [

      • {

        • "id": "component-1",
        • "properties": {

          • "lowLatency": true,
          • "persistent": true,
          • "playable": true,
          • "subscribeMode": "auto",
          • "targetWindowDuration": 0

          },
        • "tracks": [

          • {

            • "id": "string",
            • "metadata": null,
            • "type": "audio"

            }

          ],
        • "type": "hls"

        }

      ],
    • "config": {

      • "maxPeers": 10,
      • "peerDisconnectedTimeout": 60,
      • "peerlessPurgeTimeout": 60,
      • "roomId": "string",
      • "videoCodec": "h264",
      • "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"

      },
    • "id": "room-1",
    • "peers": [

      • {

        • "id": "peer-1",
        • "metadata": {

          • "name": "FishjamUser"

          },
        • "status": "disconnected",
        • "tracks": [

          • {

            • "id": "string",
            • "metadata": null,
            • "type": "audio"

            }

          ],
        • "type": "webrtc"

        }

      ]

    }

  }

}

Delete the room

Authorizations:

authorization

path Parameters

room_id required

string Room id

Responses

https://raw.githubusercontent.com/room/{room_id}

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}

Shows information about the room

Authorizations:

authorization

path Parameters

room_id required

string Room ID

Responses

https://raw.githubusercontent.com/room/{room_id}

Response samples

• 200
• 400
• 401
• 404
• 503

Content type

application/json

{

• "data": {

  • "components": [

    • {

      • "id": "component-1",
      • "properties": {

        • "lowLatency": true,
        • "persistent": true,
        • "playable": true,
        • "subscribeMode": "auto",
        • "targetWindowDuration": 0

        },
      • "tracks": [

        • {

          • "id": "string",
          • "metadata": null,
          • "type": "audio"

          }

        ],
      • "type": "hls"

      }

    ],
  • "config": {

    • "maxPeers": 10,
    • "peerDisconnectedTimeout": 60,
    • "peerlessPurgeTimeout": 60,
    • "roomId": "string",
    • "videoCodec": "h264",
    • "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"

    },
  • "id": "room-1",
  • "peers": [

    • {

      • "id": "peer-1",
      • "metadata": {

        • "name": "FishjamUser"

        },
      • "status": "disconnected",
      • "tracks": [

        • {

          • "id": "string",
          • "metadata": null,
          • "type": "audio"

          }

        ],
      • "type": "webrtc"

      }

    ]

  }

}

Creates the component and adds it to the room

Authorizations:

authorization

path Parameters

room_id required

string Room ID

Request Body schema: application/json

optional

Component config

	ComponentOptionsHLS (object) or ComponentOptionsRTSP (object) or ComponentOptionsFile (object) or ComponentOptionsSIP (object) or ComponentOptionsRecording (object) (ComponentOptions) Component-specific options
type required	string (ComponentType) Component type

Responses

https://raw.githubusercontent.com/room/{room_id}/component

Request samples

• Payload

Content type

application/json

{

• "options": {

  • "lowLatency": false,
  • "persistent": false,
  • "s3": {

    • "accessKeyId": "string",
    • "bucket": "string",
    • "region": "string",
    • "secretAccessKey": "string"

    },
  • "subscribeMode": "auto",
  • "targetWindowDuration": 0

  },
• "type": "hls"

}

Response samples

• 201
• 400
• 401
• 404
• 503

Content type

application/json

{

• "data": {

  • "id": "component-1",
  • "properties": {

    • "lowLatency": true,
    • "persistent": true,
    • "playable": true,
    • "subscribeMode": "auto",
    • "targetWindowDuration": 0

    },
  • "tracks": [

    • {

      • "id": "string",
      • "metadata": null,
      • "type": "audio"

      }

    ],
  • "type": "hls"

  }

}

Subscribe component to the tracks of peers or components

Authorizations:

authorization

path Parameters

room_id required	string Room ID
component_id required	string Component ID

Request Body schema: application/json

optional

Subscribe configuration

origins

Array of strings List of peers and components ids whose tracks the HLS endpoint will subscribe to

Responses

https://raw.githubusercontent.com/room/{room_id}/component/{component_id}/subscribe

Request samples

• Payload

Content type

application/json

{

• "origins": [

  • "string"

  ]

}

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}

Delete the component from the room

Authorizations:

authorization

path Parameters

room_id required	string Room ID
id required	string Component ID

Responses

https://raw.githubusercontent.com/room/{room_id}/component/{id}

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}

Create peer

Authorizations:

authorization

path Parameters

room_id required

string Room id

Request Body schema: application/json

optional

Peer specification

required	PeerOptionsWebRTC (object) (PeerOptions) Peer-specific options
type required	string (PeerType) Peer type

Responses

https://raw.githubusercontent.com/room/{room_id}/peer

Request samples

• Payload

Content type

application/json

{

• "options": {

  • "enableSimulcast": true

  },
• "type": "webrtc"

}

Response samples

• 201
• 400
• 401
• 404
• 503

Content type

application/json

{

• "data": {

  • "peer": {

    • "id": "peer-1",
    • "metadata": {

      • "name": "FishjamUser"

      },
    • "status": "disconnected",
    • "tracks": [

      • {

        • "id": "string",
        • "metadata": null,
        • "type": "audio"

        }

      ],
    • "type": "webrtc"

    },
  • "peer_websocket_url": "www.fishjam.org/socket/peer",
  • "token": "5cdac726-57a3-4ecb-b1d5-72a3d62ec242"

  }

}

Delete peer

Authorizations:

authorization

path Parameters

room_id required	string Room ID
id required	string Peer id

Responses

https://raw.githubusercontent.com/room/{room_id}/peer/{id}

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}

sip

Finish call made by SIP component

Authorizations:

authorization

path Parameters

room_id required	string Room ID
component_id required	string SIP Component ID

Responses

https://raw.githubusercontent.com/sip/{room_id}/{component_id}/call

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}

Make a call from the SIP component to the provided phone number

Authorizations:

authorization

path Parameters

room_id required	string Room ID
component_id required	string SIP Component ID

Request Body schema: application/json

optional

Phone Number configuration

phoneNumber

string Phone number on which SIP Component will call

Responses

https://raw.githubusercontent.com/sip/{room_id}/{component_id}/call

Request samples

• Payload

Content type

application/json

{

• "phoneNumber": "string"

}

Response samples

• 400
• 401
• 404
• 503

Content type

application/json

{

• "errors": "Token has expired"

}