JetBrains Space Help

Chats

Add new channel

post /api/http/chats/channels

Rights, that may be checked: Add new channels

Request arguments

object with fields:

  • name: string Required

  • description: string Required

  • private: boolean Required

Response

M2ChannelRecord

Get or create direct messages channel

post /api/http/chats/channels/dm

Create or get a direct messages channel with a profile

Request arguments

object with fields:

  • profile: string Required

Response

M2ChannelRecord

Is name free?

post /api/http/chats/channels/is-name-free

Check whether a channel name is available. Returns true when the channel name can be used to create a new channel, false otherwise.

Request arguments

object with fields:

  • name: string Required

Response

boolean

Restore archived channel

post /api/http/chats/channels/{channel}/restore-archived

Restore an archived channel and allow new messages to be added again.

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

Response

No arguments

List all channels

get /api/http/chats/channels/all-channels

Rights, that may be checked: View channel info

Request arguments

query: string (Query) Required

Substring matching name or description of the channel

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

quickFilter: AllChannelsFilter (Query) ( Nullable and Optional , defaults to null)

Additional options to filter channels

sortColumn: AllChannelsSortColumn (Query) ( Nullable and Optional , defaults to null)

sortOrder: ColumnSortOrder (Query) ( Nullable and Optional , defaults to "ASC")

publicOnly: boolean (Query) ( Nullable and Optional , defaults to false)

withArchived: boolean (Query) ( Nullable and Optional , defaults to true)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of AllChannelsListEntry Required

Get channel

get /api/http/chats/channels/{channel}

Rights, that may be checked: View channel info

Request arguments

channel: string in one of the formats

(Path) Required

Response

M2ChannelRecord

Delete channel

delete /api/http/chats/channels/{channel}

Delete a channel. No one will be able to view this channel or its threads. This action cannot be undone.

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

Response

No arguments

Archive channel

delete /api/http/chats/channels/{channel}/archive

Archive a channel and reject new messages being added. It is still possible to view messages from an archived channel. It is possible to restore the channel later.

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

Response

No arguments

Create conversation

post /api/http/chats/channels/conversations

Rights, that may be checked: Start new conversations

Request arguments

object with fields:

  • profileIds: array of string Required

  • subject: string ( Nullable and Optional , defaults to null)

Response

M2ChannelRecord

Convert conversation to private channel

post /api/http/chats/channels/conversations/{channel}/convert

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

  • channelName: string Required

Response

M2ChannelRecord

Change conversation subject

patch /api/http/chats/channels/conversations/{channel}/subject

Rights, that may be checked: Update channel info

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

  • subject: string Required

Response

No arguments

Get channel administrator

get /api/http/chats/channels/{channel}/administrator

Rights, that may be checked: View channel participants

Request arguments

channel: string in one of the formats

(Path) Required

Response

CPrincipal

Assign channel administrator

patch /api/http/chats/channels/{channel}/administrator

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

Response

No arguments

List attachments in channel

get /api/http/chats/channels/{channel}/attachments

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelInfoAttachment Required

List file attachments in channel

get /api/http/chats/channels/{channel}/attachments/files

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelInfoAttachment Required

List images in channel

get /api/http/chats/channels/{channel}/attachments/images

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelInfoAttachment Required

get /api/http/chats/channels/{channel}/attachments/links

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelInfoAttachment Required

List videos in channel

get /api/http/chats/channels/{channel}/attachments/videos

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelInfoAttachment Required

Change channel description

patch /api/http/chats/channels/{channel}/description

Rights, that may be checked: Update channel info

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

  • description: string Required

Response

No arguments

Change channel icon

patch /api/http/chats/channels/{channel}/icon

Rights, that may be checked: Update channel info

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

  • icon: string ( Nullable and Optional , defaults to null)

Response

No arguments

Rename channel

patch /api/http/chats/channels/{channel}/name

Rights, that may be checked: Manage channels

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

  • name: string Required

Response

No arguments

Add teams to channel

post /api/http/chats/channels/{channel}/subscribers/teams

Rights, that may be checked: Add members or teams to participant list

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

Response

No arguments

List teams subscribed to channel

get /api/http/chats/channels/{channel}/subscribers/teams

Rights, that may be checked: View channel participants

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

query: string (Query) Required

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of TD_Team Required

Remove teams from channel

delete /api/http/chats/channels/{channel}/subscribers/teams

Rights, that may be checked: Remove members or teams from participant list

Request arguments

channel: string in one of the formats

(Path) Required

teams: array of TeamIdentifier (Query) Required

Response

No arguments

Add users to channel

post /api/http/chats/channels/{channel}/subscribers/users

Rights, that may be checked: Add members or teams to participant list

Request arguments

channel: string in one of the formats

(Path) Required

object with fields:

Response

No arguments

List users subscribed to channel

get /api/http/chats/channels/{channel}/subscribers/users

Rights, that may be checked: View channel participants

Request arguments

channel: string in one of the formats

(Path) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

query: string (Query) Required

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of TD_MemberProfile Required

Remove users from channel

delete /api/http/chats/channels/{channel}/subscribers/users

Rights, that may be checked: Remove members or teams from participant list

Request arguments

channel: string in one of the formats

(Path) Required

profiles: array of ProfileIdentifier (Query) Required

Response

No arguments

Delete message

post /api/http/chats/messages/delete-message

Delete a message from a channel.

Rights, that may be checked: Post messages, Post messages in threads

Request arguments

object with fields:

Response

No arguments

Edit message

post /api/http/chats/messages/edit-message

Edit an existing message. Message content can be a string, or a block with one or several sections of information.

Rights, that may be checked: Post messages, Post messages in threads

Request arguments

object with fields:

Response

No arguments

Import messages

post /api/http/chats/messages/import

This API method is intended to be used only by applications.

Rights, that may be checked: Import messages

Request arguments

object with fields:

Response

No arguments

Send text message

post /api/http/chats/messages/send

Rights, that may be checked: Post messages, Post messages in threads

Request arguments

object with fields:

  • channel: string Required

  • text: string Required

  • pending: boolean ( Optional , defaults to false)

  • temporaryId: string ( Nullable and Optional , defaults to null)

Response

ChannelItemRecord

Send message

post /api/http/chats/messages/send-message

Send a message to a channel, thread, member, issue, code review, etc. Message content can be a string, or a block with one or several sections of information.

Rights, that may be checked: Post messages, Post messages in threads

Request arguments

object with fields:

  • channel: ChannelIdentifier ( Nullable and Optional , defaults to null)

  • content: ChatMessage Required

  • attachments: array of AttachmentIn ( Nullable and Optional , defaults to null)

  • unfurlLinks: boolean ( Nullable and Optional , defaults to null)

  • externalId: string ( Nullable and Optional , defaults to null)

  • resolveNames: boolean ( Nullable and Optional , defaults to null)

  • pending: boolean ( Nullable and Optional , defaults to null)

  • recipient: MessageRecipient ( Nullable and Optional , defaults to null)

Response

ChannelItemRecord

Get channel messages

get /api/http/chats/messages

Retrieve a batch of messages from a channel. Messages are divided into batches by providing sorting, startFromDate and batchSize parameters. If the retrieved number of messages is less than batchSize, there are currently no more messages to return. Return data also contains next value for startFromDate as well as the orgLimitReached flag indicating whether part of messages could not be retrieved because of organization plan limitation.

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Query) Required

sorting: MessagesSorting (Query) Required

startFromDate: string (format: date-time) (Query) ( Nullable and Optional , defaults to null)

batchSize: integer (format: int32) (Query) Required

Response

GetMessagesResponse

Get message

get /api/http/chats/messages/{message}

Rights, that may be checked: View messages

Request arguments

message: string in one of the formats

  • externalId: string

  • id: string

(Path) Required

channel: string in one of the formats

(Query) Required

Response

ChannelItemRecord

Pin message

patch /api/http/chats/messages/pin

Rights, that may be checked: Pin or unpin messages

Request arguments

object with fields:

Response

No arguments

Unpin message

patch /api/http/chats/messages/unpin

Rights, that may be checked: Pin or unpin messages

Request arguments

object with fields:

Response

No arguments

List pinned messages in channel

get /api/http/chats/messages/pinned-messages

Rights, that may be checked: View messages

Request arguments

channel: string in one of the formats

(Query) Required

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of ChannelItemRecord Required

Last modified: 28 September 2022
Calls Checklists