🗃️Endpoints - Lives

List lives

get

List Lives

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

title[eq]stringOptionnel

Search Lives with a specific title

title[contains]stringOptionnel

Search Lives that contains this in the title

status[eq]string · enumOptionnel

Search Lives with a specific status

Valeurs possibles:

startDate[lt]integerOptionnel

Return elements with date before than this

startDate[lte]integerOptionnel

Return elements with date before than or equal to this

startDate[gt]integerOptionnel

Return elements with date after than this

startDate[gte]integerOptionnel

Return elements with date after than or equal to this

startDate[eq]integerOptionnel

Return elements with date equal to this

solution[eq]string · enumOptionnel

Search Lives with a specific solution

Valeurs possibles:

replay[eq]stringOptionnel

Search Lives with or without replay

builtInType[eq]string · enumOptionnel

Search Lives with a specific BuiltInType

Valeurs possibles:

averageViewTime[lt]integerOptionnel

Return elements with value lower than this

averageViewTime[lte]integerOptionnel

Return elements with value lower than or equal to this

averageViewTime[gt]integerOptionnel

Return elements with value greater than this

averageViewTime[gte]integerOptionnel

Return elements with value greater than or equal to this

averageViewTime[eq]integerOptionnel

Return elements with value equal to this

invited[lt]integerOptionnel

Return elements with value lower than this

invited[lte]integerOptionnel

Return elements with value lower than or equal to this

invited[gt]integerOptionnel

Return elements with value greater than this

invited[gte]integerOptionnel

Return elements with value greater than or equal to this

invited[eq]integerOptionnel

Return elements with value equal to this

registrant[lt]integerOptionnel

Return elements with value lower than this

registrant[lte]integerOptionnel

Return elements with value lower than or equal to this

registrant[gt]integerOptionnel

Return elements with value greater than this

registrant[gte]integerOptionnel

Return elements with value greater than or equal to this

registrant[eq]integerOptionnel

Return elements with value equal to this

attendee[lt]integerOptionnel

Return elements with value lower than this

attendee[lte]integerOptionnel

Return elements with value lower than or equal to this

attendee[gt]integerOptionnel

Return elements with value greater than this

attendee[gte]integerOptionnel

Return elements with value greater than or equal to this

attendee[eq]integerOptionnel

Return elements with value equal to this

attendanceRate[lt]integerOptionnel

Return elements with value lower than this

attendanceRate[lte]integerOptionnel

Return elements with value lower than or equal to this

attendanceRate[gt]integerOptionnel

Return elements with value greater than this

attendanceRate[gte]integerOptionnel

Return elements with value greater than or equal to this

attendanceRate[eq]integerOptionnel

Return elements with value equal to this

totalReplayView[lt]integerOptionnel

Return elements with value lower than this

totalReplayView[lte]integerOptionnel

Return elements with value lower than or equal to this

totalReplayView[gt]integerOptionnel

Return elements with value greater than this

totalReplayView[gte]integerOptionnel

Return elements with value greater than or equal to this

totalReplayView[eq]integerOptionnel

Return elements with value equal to this

Réponses

200

Lives returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/lives HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2025-05-15T01:22:21.411Z",
      "endDate": "2025-05-15T01:22:21.411Z",
      "metrics": {
        "averageViewTime": 1,
        "noShow": 1,
        "totalReplayView": 1,
        "registrant": 1,
        "attendee": 1,
        "attendanceRate": 1,
        "invited": 1
      },
      "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",
      "videoUrl": {},
      "createdAt": "2025-05-15T01:22:21.411Z",
      "spotId": "text",
      "builtInConfig": {
        "isRecorded": true,
        "recordAvailable": true,
        "videos": {
          "url": "text",
          "quality": "text",
          "encoding": "hls",
          "createdAt": "2025-05-15T01:22:21.411Z"
        },
        "replayVideo": {}
      }
    }
  ],
  "total": 1
}

Create a live

post

Create a Live

Corps

titlestringRequis

The title of the Live

descriptionstringOptionnel

Description of the Live (in Markdown)

spotMemberHostIdstringRequis

The Spot member host of the Live

startDateintegerRequis

Start date of the Live (Unix timestamp format)

endDateintegerRequis

End date of the Live (Unix timestamp format)

solutionstring · enumRequis

Solution of the Live

Valeurs possibles:

builtInTypestring · enum | nullableOptionnel

BuiltIn type of the Live (if solution is BuiltIn)

Valeurs possibles:

videoUrlobject | nullableOptionnel

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

chatVisibilitystring · enumOptionnel

The chat visibility on the Live

Valeurs possibles:

participantsVisibilitystring · enumOptionnel

The participant list visibility on the Live

Valeurs possibles:

visibilitystring · enumOptionnel

The Live visibility

Valeurs possibles:

participationstring · enumOptionnel

Who kind of members can participate to the Live

Valeurs possibles:

recordbooleanOptionnel

Active the record on the Live

Réponses

201

Live has been successfully created

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/lives HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "title": "text",
  "description": "text",
  "spotMemberHostId": "text",
  "startDate": 1,
  "endDate": 1,
  "solution": "Youtube",
  "builtInType": "Workshop",
  "videoUrl": {},
  "chatVisibility": "Display",
  "participantsVisibility": "Display",
  "visibility": "AnyOne",
  "participation": "AnySpotMembers",
  "record": true
}

{
  "id": "text",
  "title": "text",
  "startDate": "2025-05-15T01:22:21.411Z",
  "endDate": "2025-05-15T01:22:21.411Z",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "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",
  "videoUrl": {},
  "createdAt": "2025-05-15T01:22:21.411Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-05-15T01:22:21.411Z"
    },
    "replayVideo": {}
  }
}

Delete a live

delete

Delete a Live

Paramètres de chemin

liveIdstringRequis

The id of the Live

Réponses

204

Live successfully deleted

400

Malformed payload

404

Live not found

delete

HTTPcURLJavaScriptPython

DELETE /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

Update a live

put

Update a Live

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

titlestringRequis

The title of the Live

descriptionstringOptionnel

Description of the Live (in Markdown)

startDateintegerRequis

Start date of the Live (Unix timestamp format)

endDateintegerRequis

End date of the Live (Unix timestamp format)

chatVisibilitystring · enumOptionnel

The chat visibility on the Live

Valeurs possibles:

participantsVisibilitystring · enumOptionnel

The participant list visibility on the Live

Valeurs possibles:

visibilitystring · enumOptionnel

The Live visibility

Valeurs possibles:

participationstring · enumOptionnel

Who kind of members can participate to the Live

Valeurs possibles:

solutionstring · enumRequis

Solution of the Live

Valeurs possibles:

builtInTypestring · enumOptionnel

BuiltIn type of the Live (if solution is BuiltIn)

Valeurs possibles:

recordbooleanOptionnel

Active the record on the Live

recordAvailablebooleanOptionnel

Make available the record of the Live

videoUrlstringOptionnel

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

replayVideoUrlobject | nullableOptionnel

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

Réponses

200

Live successfully updated

application/json

400

Malformed payload

404

Live not found

put

HTTPcURLJavaScriptPython

PUT /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "title": "text",
  "description": "text",
  "startDate": 1,
  "endDate": 1,
  "chatVisibility": "Display",
  "participantsVisibility": "Display",
  "visibility": "AnyOne",
  "participation": "AnySpotMembers",
  "solution": "Youtube",
  "builtInType": "Workshop",
  "record": true,
  "recordAvailable": true,
  "videoUrl": "text",
  "replayVideoUrl": {}
}

{
  "id": "text",
  "title": "text",
  "startDate": "2025-05-15T01:22:21.411Z",
  "endDate": "2025-05-15T01:22:21.411Z",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "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",
  "videoUrl": {},
  "createdAt": "2025-05-15T01:22:21.411Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-05-15T01:22:21.411Z"
    },
    "replayVideo": {}
  }
}

Get a live

get

Get a Live

Paramètres de chemin

liveIdstringRequis

The id of the Live

Réponses

200

Live found and returned successfully

application/json

400

Malformed payload

404

Live not found

get

HTTPcURLJavaScriptPython

GET /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "id": "text",
  "title": "text",
  "startDate": "2025-05-15T01:22:21.411Z",
  "endDate": "2025-05-15T01:22:21.411Z",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "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",
  "videoUrl": {},
  "createdAt": "2025-05-15T01:22:21.411Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-05-15T01:22:21.411Z"
    },
    "replayVideo": {}
  }
}

Unlike a group from a live

delete

Unlink a group from a live

Paramètres de chemin

liveIdstringRequis

The id of the Live

groupIdstringRequis

The id of the group

Réponses

204

Group successfully unlink

400

Malformed payload

404

Live or Group not found

delete

HTTPcURLJavaScriptPython

DELETE /v1/lives/{liveId}/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

Unlike multiple groups from a live

post

Unlink groups from a live

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

groupIdsstring[]Requis

The ids of the groups to link

Réponses

204

Groups successfully unlink

400

Malformed payload

404

Live not found

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "groupIds": [
    "text"
  ]
}

Aucun contenu

List groups

get

Link a group

Paramètres de chemin

liveIdstringRequis

The id of the Live

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

Réponses

200

Group returned successfully

application/json

400

Malformed payload

404

Live not found

get

HTTPcURLJavaScriptPython

GET /v1/lives/{liveId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Link a group

post

Link a group

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

groupIdstringRequis

The id of the group to link

withEmailNotificationbooleanOptionnel

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

Réponses

204

Group linked successfully

400

Malformed payload

404

Live not found

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "groupId": "text",
  "withEmailNotification": true
}

Aucun contenu

Link multiple groups

post

Link groups

Paramètres de chemin

channelIdstringRequis

The id of the channel

Corps

groupIdsstring[]Requis

The ids of the groups to link

Réponses

204

Groups linked successfully

400

Malformed payload

404

Channel not found

post

HTTPcURLJavaScriptPython

POST /v1/channels/{channelId}/groups~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "groupIds": [
    "text"
  ]
}

Aucun contenu

Invite a member as live speaker

post

Invite a member as Live speaker

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

memberone ofRequis

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

ou

stringOptionnel

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

highlightedbooleanOptionnel

Set to true to highlight the Speaker.

Default: false

grantHostRightsbooleanOptionnel

Set to true to grant Host rights to the Speaker.

Default: false

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false

Réponses

200

Member already invited & ignored because invalid status

201

Member has been successfully invited

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/speakers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "member": {
    "email": "text",
    "firstName": "text",
    "lastName": "text",
    "title": "text",
    "biography": "text"
  },
  "invitedBySpotMemberId": "text",
  "highlighted": false,
  "grantHostRights": false,
  "withEmailNotification": false
}

Aucun contenu

Liste live speaker

get

List Live speakers

Paramètres de chemin

liveIdstringRequis

The id of the Live

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

firstname[eq]stringOptionnel

Search participants with a specific firstname

firstname[contains]stringOptionnel

Search participants that contains this in the firstname

lastname[eq]stringOptionnel

Search participants with a specific lastname

lastname[contains]stringOptionnel

Search participants that contains this in the lastname

email[eq]stringOptionnel

Search participants with a specific email

email[contains]stringOptionnel

Search participants that contains this in the email

status[eq]string · enumOptionnel

Search participants with a specific status

Valeurs possibles:

hasReplayed[eq]stringOptionnel

Search for participants who replayed the Live

hasParticipated[eq]stringOptionnel

Search for participants who participated to the Live

Réponses

200

Live speakers returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/lives/{liveId}/speakers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2025-05-15T01:22:21.411Z",
      "registeredAt": "2025-05-15T01:22:21.411Z",
      "isHighlighted": true,
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ],
  "total": 1
}

Invite a member as live participant

post

Invite a member as Live participant

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

memberstringRequis

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

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Réponses

200

Member already invited

201

Member has been successfully invited

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "member": "text",
  "invitedBySpotMemberId": "text",
  "withEmailNotification": true
}

Aucun contenu

List live participants

get

List Live participants

Paramètres de chemin

liveIdstringRequis

The id of the Live

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

firstname[eq]stringOptionnel

Search participants with a specific firstname

firstname[contains]stringOptionnel

Search participants that contains this in the firstname

lastname[eq]stringOptionnel

Search participants with a specific lastname

lastname[contains]stringOptionnel

Search participants that contains this in the lastname

email[eq]stringOptionnel

Search participants with a specific email

email[contains]stringOptionnel

Search participants that contains this in the email

type[eq]string · enumOptionnel

Search participants with a specific type

Valeurs possibles:

status[eq]string · enumOptionnel

Search participants with a specific status

Valeurs possibles:

hasReplayed[eq]stringOptionnel

Search for participants who replayed the Live

hasParticipated[eq]stringOptionnel

Search for participants who participated to the Live

Réponses

200

Live participants returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/lives/{liveId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2025-05-15T01:22:21.411Z",
      "registeredAt": "2025-05-15T01:22:21.411Z",
      "isHighlighted": true,
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ],
  "total": 1
}

Invite multiple members as live speaker

post

Invite multiple members as Live speaker

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

highlightedbooleanOptionnel

Set to true to highlight the Speaker.

Default: false

grantHostRightsbooleanOptionnel

Set to true to grant Host rights to the Speaker.

Default: false

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Default: false

spotMemberIdsstring[]Requis

Spot members to invite as Live speaker

Réponses

200

Members has been successfully invited

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/speakers~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "invitedBySpotMemberId": "text",
  "highlighted": false,
  "grantHostRights": false,
  "withEmailNotification": false,
  "spotMemberIds": [
    "text"
  ]
}

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2025-05-15T01:22:21.411Z",
    "registeredAt": "2025-05-15T01:22:21.411Z",
    "isHighlighted": true,
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]

Invite multiple members as live participants

post

Invite multiple members as Live participant

Paramètres de chemin

liveIdstringRequis

The id of the Live

Corps

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

membersall ofRequis

Members to invite

Réponses

200

Members has been successfully invited

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

POST /v1/lives/{liveId}/participants~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "invitedBySpotMemberId": "text",
  "withEmailNotification": true,
  "members": {
    "spotMemberIds": [
      "text"
    ],
    "emails": [
      "text"
    ]
  }
}

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2025-05-15T01:22:21.411Z",
    "registeredAt": "2025-05-15T01:22:21.411Z",
    "isHighlighted": true,
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]