Chats

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

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

Response
`boolean`

Import message history

post /api/http/chats/channels/{channel}/import

Request arguments

channel: string (Path)

object with fields:

messages: array of MessageForImport

Response
array of `string`

Restore archived channel

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

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

Request arguments

channel: string in one of the formats

application: string
article: string
channel: ChatChannel
contactKey: string
id: string
issue: IssueIdentifier
member: ProfileIdentifier
codeReview: ReviewIdentifier
message: string

(Path)

Response
No arguments

List all channels

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

Request arguments
`query`: `string` (Query)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`quickFilter`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortColumn`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortOrder`: `ColumnSortOrder` (Query) ( Nullable and Optional , defaults to `"ASC"`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of AllChannelsListEntry

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.

Request arguments

channel: string in one of the formats

application: string
article: string
channel: ChatChannel
contactKey: string
id: string
issue: IssueIdentifier
member: ProfileIdentifier
codeReview: ReviewIdentifier
message: string

(Path)

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.

Request arguments

channel: string in one of the formats

application: string
article: string
channel: ChatChannel
contactKey: string
id: string
issue: IssueIdentifier
member: ProfileIdentifier
codeReview: ReviewIdentifier
message: string

(Path)

Response
No arguments

Send text message

post /api/http/chats/channels/{channel}/messages

Send a message to a channel. Message text is a string.

Request arguments

channel: string (Path)

object with fields:

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

Response
`ChannelItemRecord`

Delete message

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

Delete a message from a channel

Request arguments

object with fields:

channel: string
id: ChatMessageIdentifier

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.

Request arguments

object with fields:

channel: string
message: ChatMessageIdentifier
content: ChatMessage
unfurlLinks: boolean ( Nullable and Optional , defaults to null)

Response
No arguments

Edit text message

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

Request arguments

object with fields:

channelId: string
text: string
messageId: string

Response
No arguments

Send text message (Deprecated)

post /api/http/chats/messages/send

Request arguments

object with fields:

channel: string
text: string
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 recipient, such as a channel, member, issue, code review, ... Message content can be a string, or a block with one or several sections of information.

Request arguments

object with fields:

recipient: MessageRecipient
content: ChatMessage
unfurlLinks: boolean ( Nullable and Optional , defaults to null)
attachments: array of AttachmentIn ( 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)

Response
`ChannelItemRecord`

Last modified: 27 May 2022