🗃️Endpoints - Les lives

Lister les lives du Spot

List Lives

GET/v1/lives

Query parameters

Response

Lives returned successfully

Body

items*array of LiveApiResponse (object)

The items found

total*integer

The total number of items found

Request

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

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2024-11-21T06:29:42.669Z",
      "endDate": "2024-11-21T06:29:42.669Z",
      "metrics": {},
      "description": [
        "text"
      ],
      "status": "Ended",
      "computedStatus": "Ended",
      "solution": "Youtube",
      "privacy": {
        "visibility": "AnyOne",
        "participation": "AnySpotMembers"
      },
      "config": {
        "chatVisibility": "Display",
        "participantsVisibility": "Ended"
      },
      "builtInType": "Workshop",
      "createdAt": "2024-11-21T06:29:42.669Z",
      "spotId": "text",
      "builtInConfig": {
        "isRecorded": false,
        "recordAvailable": false,
        "videos": {
          "url": "text",
          "quality": "text",
          "encoding": "hls",
          "createdAt": "2024-11-21T06:29:42.669Z"
        }
      }
    }
  ]
}

Créer un Live

Create a Live

POST/v1/lives

Body

title*string

The title of the Live

description*string

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

Live has been successfully created

Body

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 string

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

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

Response

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T06:29:42.669Z",
  "endDate": "2024-11-21T06:29:42.669Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T06:29:42.669Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T06:29:42.669Z"
    }
  }
}

Récupérer un live du Spot

Get a Live

GET/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

Live found and returned successfully

Body

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 string

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

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

Response

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T06:29:42.669Z",
  "endDate": "2024-11-21T06:29:42.669Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T06:29:42.669Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T06:29:42.669Z"
    }
  }
}

Modifier un live du Spot

Update a Live

PUT/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Body

title*string

The title of the Live

description*string

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

Live successfully updated

Body

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 string

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

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

Response

{
  "id": "text",
  "title": "text",
  "startDate": "2024-11-21T06:29:42.669Z",
  "endDate": "2024-11-21T06:29:42.669Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-11-21T06:29:42.669Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-11-21T06:29:42.669Z"
    }
  }
}

Supprimer un live du Spot

Delete a Live

DELETE/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

Live successfully deleted

Request

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

Désassocier un groupe d'un live

Unlink a group from a live

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

Path parameters

liveId*string

The id of the Live

groupId*string

The id of the group

Response

Group successfully unlink

Request

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

Désassocier plusieurs groupes d'un live

Unlink groups from a live

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

Path parameters

liveId*string

The id of the Live

Body

groupIds*array of string

The ids of the groups to link

Response

Groups successfully unlink

Request

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

Lister les groupes d'un live

Link a group

GET/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Query parameters

Response

Group returned successfully

Body

items*array of GroupApiResponse (object)

The items found

total*integer

The total number of items found

Request

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

Response

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

Associer un groupe à un live

Link a group

POST/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Body

groupId*string

The id of the group to link

withEmailNotificationboolean

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

Response

Group linked successfully

Request

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

Associer plusieurs groupes à un live

Link groups

POST/v1/lives/{liveId}/groups~bulkAdd

Path parameters

liveId*string

The id of the Live

Body

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

Groups linked successfully

Request

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

Lister les speakers d'un live

List Live speakers

GET/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Query parameters

Response

Live speakers returned successfully

Body

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

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

Response

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-11-21T06:29:42.669Z",
      "registeredAt": "2024-11-21T06:29:42.669Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Lister les participants d'un live

List Live participants

GET/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Query parameters

Response

Live participants returned successfully

Body

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

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

Response

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-11-21T06:29:42.669Z",
      "registeredAt": "2024-11-21T06:29:42.669Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Inviter un membre au live

Invite a member as Live participant

POST/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Body

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

Member has been successfully invited

Body

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

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

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

Response

{
  "id": "text",
  "liveId": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-11-21T06:29:42.669Z",
  "registeredAt": "2024-11-21T06:29:42.669Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

Inviter plusieurs membres à un live

Invite multiple members as Live participant

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

Path parameters

liveId*string

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

members*all of

Members to invite

Response

Members has been successfully invited

Body

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

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

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

Response

[
  {
    "id": "text",
    "liveId": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-11-21T06:29:42.669Z",
    "registeredAt": "2024-11-21T06:29:42.669Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]

Inviter un speaker à un live

Invite a member as Live speaker

POST/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Body

member*one of

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

highlightedboolean

Set to true to highlight the Speaker. False by default

grantHostRightsboolean

Set to true to grant Host rights to the Speaker. False by default

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

Member has been successfully invited

Body

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

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

const response = await fetch('/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

{
  "id": "text",
  "liveId": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-11-21T06:29:42.669Z",
  "registeredAt": "2024-11-21T06:29:42.669Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

Inviter plusieurs speakers à un live

Invite multiple members as Live speaker

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

Path parameters

liveId*string

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

spotMemberIds*array of string

Spot members to invite as Live speaker

Response

Members has been successfully invited

Body

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

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

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

Response

[
  {
    "id": "text",
    "liveId": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-11-21T06:29:42.669Z",
    "registeredAt": "2024-11-21T06:29:42.669Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]

PrécédentEndpoints - Les membres du Spot SuivantEndpoints - Les cours

Dernière mise à jour il y a 1 mois