Endpoints - Channels

PrécédentEndpoints - Courses SuivantEndpoints - Forums

Dernière mise à jour il y a 6 mois

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

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
}

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
}

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
}

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
}

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

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

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
}

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

Endpoints - Channels

Endpoints - Channels

List channel members

Add member to a channel

Create a channel

List channels

Delete a channel

Update a channel

Get a channel

Add multiple members to a channel

Remove multiple members from a channel

Create multiple channels

Link a group

List groups linked to a channel

Unlink a group from a channel

Link multiple groups to a channel

Unlink multiple groups from a channel

List channel members

Add member to a channel

Create a channel

List channels

Delete a channel

Update a channel

Get a channel

Add multiple members to a channel

Remove multiple members from a channel

Create multiple channels

Link a group

List groups linked to a channel

Unlink a group from a channel

Link multiple groups to a channel

Unlink multiple groups from a channel