Helpdesk
RoadmapGo to MeltingSpot
Français
Français
  • Pour commencer
    • 📝Introduction
    • 🗝️Concepts clés
    • 👋Rejoindre un Spot
    • 🎯Créer un Spot
  • Contenu d'un Spot
    • 🏠Page d'accueil
    • ▶️Lives
      • ➕Créer un live
      • ➕Créer un replay
      • 👣Accéder aux paramètres d'un live
      • ⚙️Paramètres généraux
      • 🔓Confidentialité
      • 🎥Paramètres vidéo
      • ⚙️Paramètres de la liveroom
      • 💌Invitations & participants
      • 👥Gérer les groupes invités
      • 🎙️Speakers
      • 📩Notifications
      • 🏷️Tags sur les lives
      • ✔️S'inscrire à un live
      • 📋Avant de démarrer un live
      • ⏸️Démarrer un live
      • ⏯️Terminer un live
      • 📊Métriques d'un live
    • 🎓Cours
      • 📂Modules
      • ➕Créer un cours
      • 👣Configurer des étapes
      • ⁉️Quiz
      • 🛣️Accéder aux paramètres d'un cours
      • ⚙️Paramètres généraux
      • 💌Invitations & participants
      • 👥Gérer les groupes invités
      • 📩Notifications
      • ✏️Le mode brouillon
      • 📋Suivre un cours
    • 💬Discussions
      • 🔉Créer un canal
      • ⚙️Paramètres d'un canal
      • ➕Ajouter et supprimer des membres d'un canal
      • 🧰Forum
      • 👉Sujet dans un Forum
      • ➕Ajouter et supprimer des membres d'un forum secret
      • ⬆️Voter, trier et chercher dans les Sujets
      • 📌Partager, épingler et marquer un Sujet comme résolu
      • ⬇️Voter, trier et épingler des réponses à un Sujet
      • 📪Notifications dans les forums
      • 🖍️Rédiger un message
      • 👋Mentionner un membre
      • ❌Editer ou supprimer un message
      • 🗣️Répondre à un message
      • ❤️Réagir à un message
    • 📚Collections
      • 🆕Gérer une collection
      • 🔐Gestion des membres/groupes d'une collection privée
      • 📃Créer et supprimer une page
      • 🔗Ajouter & supprimer un lien
      • ✏️Le mode brouillon
      • 🏷️Tags et réactions sur les documents
    • 🔍Annuaire des membres
      • 📰Profil public d'un membre
      • 🤸‍♂️Activités d'un membre
      • 🏷️Tags sur les membres
    • 🗣️Messages directs
    • 🔍Rechercher dans le Spot
  • Gérer un Spot
    • ⚙️Accéder aux paramètres
    • 📊Dashboard
      • 📈Aperçu
      • 🤿Activités
      • ▶️Lives
    • 👥Audience
      • 👥Membres
        • 🎭Rôle des membres
        • 🎓Statut des membres
        • 📩Inviter de nouveaux membres
        • 🗃️Importer des membres
        • 👀Suivre les sources d'inscription (UTM)
        • 💬Bulk Message
        • 🌠Date de dernière activité
        • 👾Propriétés personnalisées
      • 🧑‍🤝‍🧑Groupes
        • ✍️Groupes statiques
        • 🤖Groupes automatisés
      • 👤Droits utilisateurs
        • ⚙️Gestion des rôles
        • 🧢Assigner des rôles à des membres
        • 🤝Permissions
    • 🏷️Tags
    • 👀Modération
    • ⚙️Paramètres généraux
    • 🎨Personnalisation
      • ✨Thème
      • 🏗️Fonctionnalités
      • 🧑‍💻Scripts
    • 📨Notifications par email
    • ❓Formulaire d'inscription
    • 🔗Intégrations
      • 🪝Webhooks
      • 🤖API
        • 🧑‍🏫REST API
        • 🔦Configuration
        • 🗃️Endpoints - Les membres du Spot
        • 🗃️Endpoints - Les lives
        • 🗃️Endpoints - Les cours
        • 🗃️Endpoints - Les canaux
        • 🗃️Endpoints - Les forums
        • 🗃️Endpoints - Les sujets
        • 🗃️Endpoints - Les groupes
        • 🗃️Endpoints - Les tags
        • 🗃️Endpoints - Les propriétés personnalisées
        • 🗃️Endpoints - Recherche
        • 🗃️Endpoints - Notifications
      • 🧡HubSpot
    • 🔑Single Sign-On
    • 🧩Embed
    • 💁‍♂️Widget
      • 📚Liste de contenus
      • 🎓Cours
      • 📃Document
      • 🧑‍🏫Implémentation
  • Paramètres utilisateur
    • 🔔Gestion des notifications
      • 💌Email Digest
    • 👤Gérer mes profils
    • 🙌Etre membre de plusieurs Spots
    • 🔔Centre de Notifications
  • Guides
    • 🧐Accéder à MeltingSpot
    • ⏹️Ajoutez MeltingSpot à l'écran d'accueil de votre téléphone/ordinateur
    • 🔥Créer un contact HubSpot à chaque nouvelle inscription au Spot
    • ✨Notifier le début d'un live sur Slack
    • 📅Envoyer une invitation google agenda aux nouveaux participants à un live
    • 🗒️Ajouter les nouveaux membres de votre Spot dans un Google Sheet
    • ❔Utiliser le webhook Réponse au formulaire d'inscription
    • 🪃Utiliser un webhook dans Slack
    • ❔Afficher un Google Form dans une page de votre Spot
    • 🐞Résoudre un problème dans la live room
    • 🐝Accéder à son compte de facturation
    • ❓FAQ
Propulsé par GitBook
Sur cette page

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

  1. Gérer un Spot
  2. Intégrations
  3. API

Endpoints - Les canaux

PrécédentEndpoints - Les coursSuivantEndpoints - Les forums

Dernière mise à jour il y a 5 mois

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

Créer un canal

Lister les canaux du Spot

Lister les membres d'un canal

Ajouter un membre à un canal

Supprimer un canal

Modifier un canal

Récupérer un canal

Ajouter plusieurs membres à un canal

Supprimer plusieurs membres d'un canal

Créer plusieurs canaux

Associer un groupe à un canal

Lister les groupes d'un canal

Désassocier un groupe d'un canal

Associer plusieurs groupes à un canal

Désassocier plusieurs groupes d'un canal

🔗
🤖
🗃️
get

list a group

Paramètres de chemin
channelIdstringRequis

The id of the channel

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
Channel not found
get
GET /v1/channels/{channelId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ],
  "total": 1
}
get

List channels

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
Channels returned successfully
application/json
400
Malformed payload
get
GET /v1/channels HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": {},
      "privacy": "Private",
      "autoJoin": true,
      "showMembers": true
    }
  ],
  "total": 1
}
get

List Channel members

Paramètres de chemin
channelIdstringRequis

The id of the channel

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

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

registrationDate[before]integerOptionnel

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integerOptionnel

Spot members where registration date is after a specific date (Unix timestamp format)

Réponses
200
Channel members returned successfully
application/json
400
Malformed payload
get
GET /v1/channels/{channelId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "total": 1
}
delete

Delete a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Réponses
204
Channel successfully deleted
400
Malformed payload
404
Channel not found
delete
DELETE /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

get

Get a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Réponses
200
Channel found and returned successfully
application/json
400
Malformed payload
404
Channel not found
get
GET /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "showMembers": true
}
delete

Unlink a group from a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

groupIdstringRequis

The id of the group

Réponses
204
Group successfully unlink
400
Malformed payload
404
Channel or Group not found
delete
DELETE /v1/channels/{channelId}/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

  • Créer un canal
  • POST/v1/channels
  • Lister les canaux du Spot
  • GET/v1/channels
  • Lister les membres d'un canal
  • GET/v1/channels/{channelId}/spotMembers
  • Ajouter un membre à un canal
  • POST/v1/channels/{channelId}/spotMembers
  • Supprimer un canal
  • DELETE/v1/channels/{channelId}
  • Modifier un canal
  • PUT/v1/channels/{channelId}
  • Récupérer un canal
  • GET/v1/channels/{channelId}
  • Ajouter plusieurs membres à un canal
  • POST/v1/channels/{channelId}/spotMembers~bulkAdd
  • Supprimer plusieurs membres d'un canal
  • POST/v1/channels/{channelId}/spotMembers~bulkRemove
  • Créer plusieurs canaux
  • POST/v1/channels~bulkCreate
  • Associer un groupe à un canal
  • POST/v1/channels/{channelId}/groups
  • Lister les groupes d'un canal
  • GET/v1/channels/{channelId}/groups
  • Désassocier un groupe d'un canal
  • DELETE/v1/channels/{channelId}/groups/{groupId}
  • Associer plusieurs groupes à un canal
  • POST/v1/channels/{channelId}/groups~bulkAdd
  • Désassocier plusieurs groupes d'un canal
  • POST/v1/channels/{channelId}/groups~bulkRemove
post

Create a channel

Corps
namestringRequis

The name of the channel.

descriptionstringOptionnel

The description of the channel

emojistringOptionnel

The emoji of the channel

autoJoinbooleanRequis

Whether the channel should be auto-joined by new members.

showMembersbooleanRequis

Whether the channel should show its members.

privacystring · enumRequis

Privacy setting of the channel

Valeurs possibles:
Réponses
201
Channel has been successfully created
application/json
400
Malformed payload
post
POST /v1/channels HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "name": "text",
  "description": "text",
  "emoji": "text",
  "autoJoin": true,
  "showMembers": true,
  "privacy": "Private"
}
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "showMembers": true
}
post

Add member to a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
spotMemberIdstringRequis

An uuid representing the unique identifier of the spot member to add to channel

Réponses
204
Member successfully added
400
Malformed payload
404
Channel not found
post
POST /v1/channels/{channelId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "spotMemberId": "text"
}

Aucun contenu

put

Update a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
namestringOptionnel

The name of the channel.

descriptionstringOptionnel

The description of the channel

emojistringOptionnel

The emoji of the channel

autoJoinbooleanOptionnel

Whether the channel should be auto-joined by new members.

showMembersbooleanOptionnel

Whether the channel should show its members.

privacystring · enumOptionnel

Privacy setting of the channel

Valeurs possibles:
Réponses
200
Channel successfully updated
application/json
400
Malformed payload
404
Channel not found
put
PUT /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "name": "text",
  "description": "text",
  "emoji": "text",
  "autoJoin": true,
  "showMembers": true,
  "privacy": "Private"
}
{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": {},
  "privacy": "Private",
  "autoJoin": true,
  "showMembers": true
}
post

Add members to a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to add to channel

Réponses
200
Members successfully added
application/json
400
Malformed payload
404
Channel not found
post
POST /v1/channels/{channelId}/spotMembers~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}
{
  "addedSpotMemberIds": [
    "text"
  ],
  "failedSpotMemberIds": [
    "text"
  ]
}
post

Remove members from a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
spotMemberIdsstring[]Requis

An array of strings representing the unique identifiers of spot members to remove from channel

Réponses
200
Members successfully removed
application/json
400
Malformed payload
404
Channel not found
post
POST /v1/channels/{channelId}/spotMembers~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}
{
  "removedSpotMembersCount": 1
}
post

Create multiple channels

Corps
namestringRequis

The name of the channel.

descriptionstringOptionnel

The description of the channel

emojistringOptionnel

The emoji of the channel

autoJoinbooleanRequis

Whether the channel should be auto-joined by new members.

showMembersbooleanRequis

Whether the channel should show its members.

privacystring · enumRequis

Privacy setting of the channel

Valeurs possibles:
Réponses
201
Channels has been successfully created
application/json
400
Malformed payload
413
Payload is too large
post
POST /v1/channels~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 108

[
  {
    "name": "text",
    "description": "text",
    "emoji": "text",
    "autoJoin": true,
    "showMembers": true,
    "privacy": "Private"
  }
]
{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": {},
      "privacy": "Private",
      "autoJoin": true,
      "showMembers": true
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": true,
      "showMembers": true,
      "privacy": "Private"
    }
  ]
}
post

Link a group

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
groupIdstringRequis

The id of the group to link

Réponses
204
Group linked successfully
400
Malformed payload
404
Channel not found
post
POST /v1/channels/{channelId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "groupId": "text"
}

Aucun contenu

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
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

post

Unlink groups from a channel

Paramètres de chemin
channelIdstringRequis

The id of the channel

Corps
groupIdsstring[]Requis

The ids of the groups to link

Réponses
204
Groups successfully unlink
400
Malformed payload
404
Channel not found
post
POST /v1/channels/{channelId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "groupIds": [
    "text"
  ]
}

Aucun contenu