🗃️Endpoints - Lives

List lives

List Lives

GEThttps://openapi.meltingspot.io/v1/lives

Query parameters

Response

200400

Lives returned successfully

Body

application/json

items*array of LiveApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2024-11-21T10:05:34.302Z",
      "endDate": "2024-11-21T10:05:34.302Z",
      "metrics": {},
      "description": [
        {
          "type": "p",
          "children": [
            {
              "text": "My new live"
            }
          ]
        }
      ],
      "status": "Ended",
      "computedStatus": "Ended",
      "solution": "Youtube",
      "privacy": {
        "visibility": "AnyOne",
        "participation": "AnySpotMembers"
      },
      "config": {
        "chatVisibility": "Display",
        "participantsVisibility": "Ended"
      },
      "builtInType": "Workshop",
      "createdAt": "2024-11-21T10:05:34.302Z",
      "spotId": "text",
      "builtInConfig": {
        "isRecorded": false,
        "recordAvailable": false,
        "videos": {
          "url": "text",
          "quality": "text",
          "encoding": "hls",
          "createdAt": "2024-11-21T10:05:34.302Z"
        }
      }
    }
  ]
}

Create a live

Create a Live

POSThttps://openapi.meltingspot.io/v1/lives

Body

application/json

title*string

The title of the Live

descriptionstring

Description of the Live (in Markdown)

spotMemberHostId*string

The Spot member host of the Live

startDate*integer

Start date of the Live (Unix timestamp format)

endDate*integer

End date of the Live (Unix timestamp format)

solution*enum

Solution of the Live

YoutubeVimeoBuiltInNoSolution

builtInTypenullable enum

BuiltIn type of the Live (if solution is BuiltIn)

WorkshopConference

videoUrlnullable object

Video URL of the Live (if solution is Youtube or Vimeo)

chatVisibilityenum

The chat visibility on the Live

DisplayHidden

participantsVisibilityenum

The participant list visibility on the Live

DisplayHidden

visibilityenum

The Live visibility

AnyOneOnlySpotMembersInvitedMembersOnly

participationenum

Who kind of members can participate to the Live

AnySpotMembersInvitedMembersOnly

recordboolean

Active the record on the Live

Response

201400

Live has been successfully created

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of object

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "spotMemberHostId": "text",
      "solution": "Youtube"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T10:05:34.302Z",
  "endDate": "2024-11-21T10:05:34.302Z",
  "metrics": {},
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T10:05:34.302Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T10:05:34.302Z"
    }
  }
}

Delete a live

Delete a Live

DELETEhttps://openapi.meltingspot.io/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

204400404

Live successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update a live

Update a Live

PUThttps://openapi.meltingspot.io/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Body

application/json

title*string

The title of the Live

descriptionstring

Description of the Live (in Markdown)

startDate*integer

Start date of the Live (Unix timestamp format)

endDate*integer

End date of the Live (Unix timestamp format)

chatVisibilityenum

The chat visibility on the Live

DisplayHidden

participantsVisibilityenum

The participant list visibility on the Live

DisplayHidden

visibilityenum

The Live visibility

AnyOneOnlySpotMembersInvitedMembersOnly

participationenum

Who kind of members can participate to the Live

AnySpotMembersInvitedMembersOnly

solution*enum

Solution of the Live

YoutubeVimeoBuiltInNoSolution

builtInTypeenum

BuiltIn type of the Live (if solution is BuiltIn)

WorkshopConference

recordboolean

Active the record on the Live

recordAvailableboolean

Make available the record of the Live

videoUrlstring

Video URL of the Live (if solution is Youtube or Vimeo)

replayVideoUrlnullable object

Video URL of the Live (if solution is Youtube or Vimeo)

Response

200400404

Live successfully updated

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of object

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "solution": "Youtube"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T10:05:34.302Z",
  "endDate": "2024-11-21T10:05:34.302Z",
  "metrics": {},
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T10:05:34.302Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T10:05:34.302Z"
    }
  }
}

Get a live

Get a Live

GEThttps://openapi.meltingspot.io/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

200400404

Live found and returned successfully

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of object

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T10:05:34.302Z",
  "endDate": "2024-11-21T10:05:34.302Z",
  "metrics": {},
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T10:05:34.302Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T10:05:34.302Z"
    }
  }
}

Unlike a group from a live

Unlink a group from a live

DELETEhttps://openapi.meltingspot.io/v1/lives/{liveId}/groups/{groupId}

Path parameters

liveId*string

The id of the Live

groupId*string

The id of the group

Response

204400404

Group successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/groups/{groupId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Unlike multiple groups from a live

Unlink groups from a live

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkRemove

Path parameters

liveId*string

The id of the Live

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

List groups

Link a group

GEThttps://openapi.meltingspot.io/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400404

Group returned successfully

Body

application/json

items*array of GroupApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ]
}

Link a group

Link a group

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Body

application/json

groupId*string

The id of the group to link

withEmailNotificationboolean

To send an email notification to each added member. Disable by default.

Response

204400404

Group linked successfully

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupId": "text"
    }),
});
const data = await response.json();

Link multiple groups

Link groups

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkAdd

Path parameters

liveId*string

The id of the Live

Body

application/json

groupIds*array of string

The ids of the groups to link

withEmailNotificationboolean

To send an email notification to each added member. Disable by default.

Response

204400404

Groups linked successfully

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Invite a member as live speaker

Invite a member as Live speaker

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Body

application/json

member*one of

Member to invite as Live participant from email address or existing Spot member ID

InviteLiveSpeakerByEmailApiBody (object)string

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

highlightedboolean

Set to true to highlight the Speaker.

grantHostRightsboolean

Set to true to grant Host rights to the Speaker.

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200201400

Member already invited & ignored because invalid status

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/speakers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "member": {
        "email": "text",
        "firstName": "text",
        "lastName": "text"
      }
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "liveId": "text",
  "spotMemberId": "text",
  "spotMemberEmail": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-11-21T10:05:34.302Z",
  "registeredAt": "2024-11-21T10:05:34.302Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

Liste live speaker

List Live speakers

GEThttps://openapi.meltingspot.io/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400

Live speakers returned successfully

Body

application/json

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/speakers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-11-21T10:05:34.302Z",
      "registeredAt": "2024-11-21T10:05:34.302Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Invite a member as live participant

Invite a member as Live participant

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Body

application/json

member*string

Member to invite as Live participant from email address or existing Spot member ID

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200201400

Member already invited

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "member": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "liveId": "text",
  "spotMemberId": "text",
  "spotMemberEmail": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-11-21T10:05:34.302Z",
  "registeredAt": "2024-11-21T10:05:34.302Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

List live participants

List Live participants

GEThttps://openapi.meltingspot.io/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400

Live participants returned successfully

Body

application/json

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-11-21T10:05:34.302Z",
      "registeredAt": "2024-11-21T10:05:34.302Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Invite multiple memers as live speaker

Invite multiple members as Live speaker

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/speakers~bulkInvite

Path parameters

liveId*string

The id of the Live

Body

application/json

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

highlightedboolean

Set to true to highlight the Speaker.

grantHostRightsboolean

Set to true to grant Host rights to the Speaker.

withEmailNotificationboolean

Set to true to send notification mail to each invited members

spotMemberIds*array of string

Spot members to invite as Live speaker

Response

200400413

Members has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

spotMemberId*string

The ID of the Spot member associated to the participant

spotMemberEmail*string

The email of the Spot member associated to the participant

spotMemberFirstname*nullable object

The Spot member firstname associated to the participant. Can be null for a participant invited by email.

spotMemberLastname*nullable object

The Spot member lastname associated to the participant. Can be null for a participant invited by email.

status*enum

The status of the participant.

AcceptedInvitedDeclined

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/speakers~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-11-21T10:05:34.302Z",
    "registeredAt": "2024-11-21T10:05:34.302Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]

Invite multiple members as live participants

Invite multiple members as Live participant

POSThttps://openapi.meltingspot.io/v1/lives/{liveId}/participants~bulkInvite

Path parameters

liveId*string

The id of the Live

Body

application/json

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

members*all of

Members to invite

Response

200400413

Members has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

spotMemberId*string

The ID of the Spot member associated to the participant

spotMemberEmail*string

The email of the Spot member associated to the participant

spotMemberFirstname*nullable object

The Spot member firstname associated to the participant. Can be null for a participant invited by email.

spotMemberLastname*nullable object

The Spot member lastname associated to the participant. Can be null for a participant invited by email.

status*enum

The status of the participant.

AcceptedInvitedDeclined

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/lives/{liveId}/participants~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "members": {}
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-11-21T10:05:34.302Z",
    "registeredAt": "2024-11-21T10:05:34.302Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]