🗃️Endpoints - Les canaux
Créer un canal
Create a channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
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
}Lister les canaux du Spot
List channels
The page number in a paginated set of results
The limit of results to be returned per page
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
}Lister les membres d'un canal
List Channel members
The id of the channel
The page number in a paginated set of results
The limit of results to be returned per page
The emails of spot member to include in the result
The firstnames of spot member to include in the result
The lastnames of spot member to include in the result
Spot members where registration date is before a specific date (Unix timestamp format)
Spot members where registration date is after a specific date (Unix timestamp format)
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
}Ajouter un membre à un canal
Add member to a channel
The id of the channel
An uuid representing the unique identifier of the spot member to add to channel
POST /v1/channels/{channelId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"spotMemberId": "text"
}Aucun contenu
Supprimer un canal
Delete a channel
The id of the channel
DELETE /v1/channels/{channelId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Modifier un canal
Update a channel
The id of the channel
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
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
}Récupérer un canal
Get a channel
The id of the channel
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
}Ajouter plusieurs membres à un canal
Add members to a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to add to channel
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"
]
}Supprimer plusieurs membres d'un canal
Remove members from a channel
The id of the channel
An array of strings representing the unique identifiers of spot members to remove from channel
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
}Créer plusieurs canaux
Create multiple channels
The name of the channel.
The description of the channel
The emoji of the channel
Whether the channel should be auto-joined by new members.
Whether the channel should show its members.
Privacy setting of the channel
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"
}
]
}Associer un groupe à un canal
Link a group
The id of the channel
The id of the group to link
POST /v1/channels/{channelId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"groupId": "text"
}Aucun contenu
Lister les groupes d'un canal
list a group
The id of the channel
The page number in a paginated set of results
The limit of results to be returned per page
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
}Désassocier un groupe d'un canal
Unlink a group from a channel
The id of the channel
The id of the group
DELETE /v1/channels/{channelId}/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Associer plusieurs groupes à un canal
Link groups
The id of the channel
The ids of the groups to link
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
Désassocier plusieurs groupes d'un canal
Unlink groups from a channel
The id of the channel
The ids of the groups to link
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
Dernière mise à jour
Cet article vous a-t-il été utile ?