Endpoints - Lives

PrécédentEndpoints - Spot Members SuivantEndpoints - Courses

Dernière mise à jour il y a 2 mois

Cet article vous a-t-il été utile ?

List Lives

get

/v1/lives

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

title[eq]string

Search Lives with a specific title

title[contains]string

Search Lives that contains this in the title

status[eq]string · enum

Search Lives with a specific status

Options: Ended, Planned, Live

startDate[lt]integer

Return elements with date before than this

startDate[lte]integer

Return elements with date before than or equal to this

startDate[gt]integer

Return elements with date after than this

startDate[gte]integer

Return elements with date after than or equal to this

startDate[eq]integer

Return elements with date equal to this

solution[in]string · enum[]

Search Lives with theses types of solution

solution[eq]string · enum

Search Lives with a specific solution

Options: Youtube, Vimeo, BuiltIn, NoSolution

replay[eq]string

Search Lives with or without replay

builtInType[in]string · enum[]

Search Lives with theses types of BuiltInType

builtInType[eq]string · enum

Search Lives with a specific BuiltInType

Options: Workshop, Conference

averageViewTime[lt]integer

Return elements with value lower than this

averageViewTime[lte]integer

Return elements with value lower than or equal to this

averageViewTime[gt]integer

Return elements with value greater than this

averageViewTime[gte]integer

Return elements with value greater than or equal to this

averageViewTime[eq]integer

Return elements with value equal to this

invited[lt]integer

Return elements with value lower than this

invited[lte]integer

Return elements with value lower than or equal to this

invited[gt]integer

Return elements with value greater than this

invited[gte]integer

Return elements with value greater than or equal to this

invited[eq]integer

Return elements with value equal to this

registrant[lt]integer

Return elements with value lower than this

registrant[lte]integer

Return elements with value lower than or equal to this

registrant[gt]integer

Return elements with value greater than this

registrant[gte]integer

Return elements with value greater than or equal to this

registrant[eq]integer

Return elements with value equal to this

attendee[lt]integer

Return elements with value lower than this

attendee[lte]integer

Return elements with value lower than or equal to this

attendee[gt]integer

Return elements with value greater than this

attendee[gte]integer

Return elements with value greater than or equal to this

attendee[eq]integer

Return elements with value equal to this

attendanceRate[lt]integer

Return elements with value lower than this

attendanceRate[lte]integer

Return elements with value lower than or equal to this

attendanceRate[gt]integer

Return elements with value greater than this

attendanceRate[gte]integer

Return elements with value greater than or equal to this

attendanceRate[eq]integer

Return elements with value equal to this

totalReplayView[lt]integer

Return elements with value lower than this

totalReplayView[lte]integer

Return elements with value lower than or equal to this

totalReplayView[gt]integer

Return elements with value greater than this

totalReplayView[gte]integer

Return elements with value greater than or equal to this

totalReplayView[eq]integer

Return elements with value equal to this

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives'

200

400

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2025-02-21T18:08:18.209Z",
      "endDate": "2025-02-21T18:08:18.209Z",
      "videoUrl": {},
      "createdAt": "2025-02-21T18:08:18.209Z",
      "spotId": "text",
      "status": "Ended",
      "computedStatus": "Ended",
      "solution": "Youtube",
      "builtInType": "Workshop",
      "metrics": {
        "averageViewTime": 1,
        "noShow": 1,
        "totalReplayView": 1,
        "registrant": 1,
        "attendee": 1,
        "attendanceRate": 1,
        "invited": 1
      },
      "privacy": {
        "visibility": "AnyOne",
        "participation": "AnySpotMembers"
      },
      "config": {
        "chatVisibility": "Display",
        "participantsVisibility": "Ended"
      },
      "builtInConfig": {
        "isRecorded": true,
        "recordAvailable": true,
        "replayVideo": {},
        "videos": {
          "url": "text",
          "quality": "text",
          "createdAt": "2025-02-21T18:08:18.209Z",
          "encoding": "hls"
        }
      },
      "description": [
        {
          "type": "p",
          "children": [
            {
              "text": "My new live"
            }
          ]
        }
      ]
    }
  ]
}

Lives returned successfully

Create a Live

post

/v1/lives

Body

titlestringrequired

The title of the Live

descriptionstring

Description of the Live (in Markdown)

spotMemberHostIdstringrequired

The Spot member host of the Live

startDateintegerrequired

Start date of the Live (Unix timestamp format)

endDateintegerrequired

End date of the Live (Unix timestamp format)

videoUrlobject | nullable

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

recordboolean

Active the record on the Live

solutionstring · enumrequired

Solution of the Live

Options: Youtube, Vimeo, BuiltIn, NoSolution

builtInTypestring · enum | nullable

BuiltIn type of the Live (if solution is BuiltIn)

Options: Workshop, Conference

chatVisibilitystring · enum

The chat visibility on the Live

Options: Display, Hidden

participantsVisibilitystring · enum

The participant list visibility on the Live

Options: Display, Hidden

visibilitystring · enum

The Live visibility

Options: AnyOne, OnlySpotMembers, InvitedMembersOnly

participationstring · enum

Who kind of members can participate to the Live

Options: AnySpotMembers, InvitedMembersOnly

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","spotMemberHostId":"text","startDate":1,"endDate":1,"videoUrl":{},"solution":"Youtube","builtInType":"Workshop","chatVisibility":"Display","participantsVisibility":"Display","visibility":"AnyOne","participation":"AnySpotMembers"}'

201

400

{
  "id": "text",
  "title": "text",
  "startDate": "2025-02-21T18:08:18.209Z",
  "endDate": "2025-02-21T18:08:18.209Z",
  "videoUrl": {},
  "createdAt": "2025-02-21T18:08:18.209Z",
  "spotId": "text",
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "builtInType": "Workshop",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "replayVideo": {},
    "videos": {
      "url": "text",
      "quality": "text",
      "createdAt": "2025-02-21T18:08:18.209Z",
      "encoding": "hls"
    }
  },
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ]
}

Live has been successfully created

Delete a Live

delete

/v1/lives/{liveId}

Path parameters

liveIdstringrequired

The id of the Live

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}'

204

400

404

No body

Live successfully deleted

Update a Live

put

/v1/lives/{liveId}

Path parameters

liveIdstringrequired

The id of the Live

Body

titlestringrequired

The title of the Live

descriptionstring

Description of the Live (in Markdown)

startDateintegerrequired

Start date of the Live (Unix timestamp format)

endDateintegerrequired

End date of the Live (Unix timestamp format)

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)

replayVideoUrlobject | nullable

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

chatVisibilitystring · enum

The chat visibility on the Live

Options: Display, Hidden

participantsVisibilitystring · enum

The participant list visibility on the Live

Options: Display, Hidden

visibilitystring · enum

The Live visibility

Options: AnyOne, OnlySpotMembers, InvitedMembersOnly

participationstring · enum

Who kind of members can participate to the Live

Options: AnySpotMembers, InvitedMembersOnly

solutionstring · enumrequired

Solution of the Live

Options: Youtube, Vimeo, BuiltIn, NoSolution

builtInTypestring · enum

BuiltIn type of the Live (if solution is BuiltIn)

Options: Workshop, Conference

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","startDate":1,"endDate":1,"replayVideoUrl":{},"chatVisibility":"Display","participantsVisibility":"Display","visibility":"AnyOne","participation":"AnySpotMembers","solution":"Youtube","builtInType":"Workshop"}'

200

400

404

{
  "id": "text",
  "title": "text",
  "startDate": "2025-02-21T18:08:18.209Z",
  "endDate": "2025-02-21T18:08:18.209Z",
  "videoUrl": {},
  "createdAt": "2025-02-21T18:08:18.209Z",
  "spotId": "text",
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "builtInType": "Workshop",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "replayVideo": {},
    "videos": {
      "url": "text",
      "quality": "text",
      "createdAt": "2025-02-21T18:08:18.209Z",
      "encoding": "hls"
    }
  },
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ]
}

Live successfully updated

Get a Live

get

/v1/lives/{liveId}

Path parameters

liveIdstringrequired

The id of the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}'

200

400

404

{
  "id": "text",
  "title": "text",
  "startDate": "2025-02-21T18:08:18.209Z",
  "endDate": "2025-02-21T18:08:18.209Z",
  "videoUrl": {},
  "createdAt": "2025-02-21T18:08:18.209Z",
  "spotId": "text",
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "builtInType": "Workshop",
  "metrics": {
    "averageViewTime": 1,
    "noShow": 1,
    "totalReplayView": 1,
    "registrant": 1,
    "attendee": 1,
    "attendanceRate": 1,
    "invited": 1
  },
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "replayVideo": {},
    "videos": {
      "url": "text",
      "quality": "text",
      "createdAt": "2025-02-21T18:08:18.209Z",
      "encoding": "hls"
    }
  },
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ]
}

Live found and returned successfully

Unlink a group from a live

delete

/v1/lives/{liveId}/groups/{groupId}

Path parameters

liveIdstringrequired

The id of the Live

groupIdstringrequired

The id of the group

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups/{groupId}'

204

400

404

No body

Group successfully unlink

Unlink groups from a live

post

/v1/lives/{liveId}/groups~bulkRemove

Path parameters

liveIdstringrequired

The id of the Live

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

404

No body

Groups successfully unlink

Link a group

get

/v1/lives/{liveId}/groups

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups'

200

400

404

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

Group returned successfully

Link a group

post

/v1/lives/{liveId}/groups

Path parameters

liveIdstringrequired

The id of the Live

Body

groupIdstringrequired

The id of the group to link

withEmailNotificationboolean

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

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups' \
  --header 'Content-Type: application/json' \
  --data '{"groupId":"text"}'

204

400

404

No body

Group linked successfully

Link groups

post

/v1/channels/{channelId}/groups~bulkAdd

Path parameters

channelIdstringrequired

The id of the channel

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

404

No body

Groups linked successfully

Invite a member as Live speaker

post

/v1/lives/{liveId}/speakers

Path parameters

liveIdstringrequired

The id of the Live

Body

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

memberone ofrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers' \
  --header 'Content-Type: application/json' \
  --data '{"highlighted":false,"grantHostRights":false,"withEmailNotification":false,"member":{"email":"text","firstName":"text","lastName":"text"}}'

200

201

400

No body

Member already invited & ignored because invalid status

List Live speakers

get

/v1/lives/{liveId}/speakers

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

firstname[eq]string

Search participants with a specific firstname

firstname[contains]string

Search participants that contains this in the firstname

lastname[eq]string

Search participants with a specific lastname

lastname[contains]string

Search participants that contains this in the lastname

email[eq]string

Search participants with a specific email

email[contains]string

Search participants that contains this in the email

status[eq]string · enum

Search participants with a specific status

Options: Accepted, Invited, Declined

status[in]string · enum[]

Search participants with one of theses status

hasReplayed[eq]string

Search for participants who replayed the Live

hasParticipated[eq]string

Search for participants who participated to the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers'

200

400

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "invitedAt": "2025-02-21T18:08:18.209Z",
      "registeredAt": "2025-02-21T18:08:18.209Z",
      "isHighlighted": true,
      "status": "Accepted",
      "type": "Participant",
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ]
}

Live speakers returned successfully

Invite a member as Live participant

post

/v1/lives/{liveId}/participants

Path parameters

liveIdstringrequired

The id of the Live

Body

memberstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants' \
  --header 'Content-Type: application/json' \
  --data '{"member":"text"}'

200

201

400

No body

Member already invited

List Live participants

get

/v1/lives/{liveId}/participants

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

firstname[eq]string

Search participants with a specific firstname

firstname[contains]string

Search participants that contains this in the firstname

lastname[eq]string

Search participants with a specific lastname

lastname[contains]string

Search participants that contains this in the lastname

email[eq]string

Search participants with a specific email

email[contains]string

Search participants that contains this in the email

type[eq]string · enum

Search participants with a specific type

Options: Participant, Speaker, Host

type[in]string · enum[]

Search participants with one of theses types

status[eq]string · enum

Search participants with a specific status

Options: Accepted, Invited, Declined

status[in]string · enum[]

Search participants with one of theses status

hasReplayed[eq]string

Search for participants who replayed the Live

hasParticipated[eq]string

Search for participants who participated to the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants'

200

400

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "invitedAt": "2025-02-21T18:08:18.209Z",
      "registeredAt": "2025-02-21T18:08:18.209Z",
      "isHighlighted": true,
      "status": "Accepted",
      "type": "Participant",
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ]
}

Live participants returned successfully

Invite multiple members as Live speaker

post

/v1/lives/{liveId}/speakers~bulkInvite

Path parameters

liveIdstringrequired

The id of the Live

Body

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

spotMemberIdsstring[]required

Spot members to invite as Live speaker

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{"highlighted":false,"grantHostRights":false,"withEmailNotification":false,"spotMemberIds":[null]}'

200

400

413

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "invitedAt": "2025-02-21T18:08:18.209Z",
    "registeredAt": "2025-02-21T18:08:18.209Z",
    "isHighlighted": true,
    "status": "Accepted",
    "type": "Participant",
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]

Members has been successfully invited

Invite multiple members as Live participant

post

/v1/lives/{liveId}/participants~bulkInvite

Path parameters

liveIdstringrequired

The id of the Live

Body

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

membersall ofrequired

Members to invite

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{"members":{"spotMemberIds":[null],"emails":[null]}}'

200

400

413

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "invitedAt": "2025-02-21T18:08:18.209Z",
    "registeredAt": "2025-02-21T18:08:18.209Z",
    "isHighlighted": true,
    "status": "Accepted",
    "type": "Participant",
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]

Members has been successfully invited

Endpoints - Lives

Endpoints - Lives

List lives

Create a live

Delete a live

Update a live

Get a live

Unlike a group from a live

Unlike multiple groups from a live

List groups

Link a group

Link multiple groups

Invite a member as live speaker

Liste live speaker

Invite a member as live participant

List live participants

Invite multiple members as live speaker

Invite multiple members as live participants

List lives

Create a live

Delete a live

Update a live

Get a live

Unlike a group from a live

Unlike multiple groups from a live

List groups

Link a group

Link multiple groups

Invite a member as live speaker

Liste live speaker

Invite a member as live participant

List live participants

Invite multiple members as live speaker

Invite multiple members as live participants