Chat

24 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

Inbox: my conversations with unread counts and previews#

GET/chat/conversationsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/conversations" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Conversation details, my state and members#

GET/chat/conversations/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

404Unknown or not readable

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Rename a group or change its description (owners)#

PATCH/chat/conversations/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateConversationDto`

Name	Typ	Beschreibung
`title`	`string`	–
`description`	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","description":"…"}'

Leave a group#

POST/chat/conversations/{id}/leaveToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/leave" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

My notification level, mute and inbox pin#

PATCH/chat/conversations/{id}/meToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateMyConversationStateDto`

Name	Typ	Beschreibung
`notifyLevel`	`string`	Werte: `allmentionsnone`
`mutedUntil`	`object`	ISO timestamp; null un-mutes
`pinned`	`boolean`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/me" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"notifyLevel":"all","mutedUntil":{},"pinned":true}'

Add people to a group#

POST/chat/conversations/{id}/membersToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonAddMembersDto`

Name	Typ	Beschreibung
`user_id`	`string`	Single user ID to add
`user_ids`	`string[]`	Multiple user IDs to add (bulk)
`role_id`	`object`	Role ID to assign to added member(s)

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/members" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"…","user_ids":[],"role_id":{}}'

Promote or demote a group member (owners)#

PATCH/chat/conversations/{id}/members/{userId}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`userId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonSetMemberRoleDto`

Name	Typ	Beschreibung
`role`Pflicht	`string`	Werte: `ownermember`

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/members/{userId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role":"owner"}'

Remove someone from a group (owners)#

DELETE/chat/conversations/{id}/members/{userId}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`userId`Pflicht	Pfad	`string`	–

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/members/{userId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

A page of the timeline (or of one thread), ordered by seq#

GET/chat/conversations/{id}/messagesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`beforeSeq`	Query	`number`	Older page: messages with seq < beforeSeq
`afterSeq`	Query	`number`	Catch-up: messages with seq > afterSeq, oldest first
`limit`	Query	`number`	–
`threadRootId`	Query	`string`	List the replies of this thread instead of the main timeline

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/messages" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Send a message (resending the same id is idempotent)#

POST/chat/conversations/{id}/messagesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonSendMessageDto`

Name	Typ	Beschreibung
`id`Pflicht	`string`	Client-generated message id; resending the same id is idempotent
`bodyHtml`Pflicht	`string`	–
`threadRootId`	`string`	Reply in the thread of this message
`quotedMessageId`	`string`	Quote this message
`objectRefs`	`ChatObjectRefDto[]`	–
`objectRefs[].type`Pflicht	`string`	Werte: `taskwiki_pageplanboardasset_objectfe_node`
`objectRefs[].id`Pflicht	`string`	–
`attachmentCount`	`number`	Files the client will upload to this message (entity_type chat_message); > 0 allows an empty body

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/messages" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","bodyHtml":"…"}'

Set my read position (markUnread moves it back)#

POST/chat/conversations/{id}/readToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonMarkReadDto`

Name	Typ	Beschreibung
`seq`Pflicht	`number`	Last read message seq
`markUnread`	`boolean`	true = move the read position back ("mark as unread")

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/conversations/{id}/read" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"seq":0}'

Open (or create) the direct message with a colleague#

POST/chat/dmsToken

Request-Body`application/jsonCreateDmDto`

Name	Typ	Beschreibung
`userId`Pflicht	`string`	The other person (public.users.id); your own id opens your notes

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/dms" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId":"…"}'

Create a group chat (you become its owner)#

POST/chat/groupsToken

Request-Body`application/jsonCreateGroupDto`

Name	Typ	Beschreibung
`title`	`string`	–
`memberIds`Pflicht	`string[]`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/groups" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"memberIds":[]}'

Edit my message (every version is kept)#

PATCH/chat/messages/{messageId}Token

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonEditMessageDto`

Name	Typ	Beschreibung
`bodyHtml`Pflicht	`string`	–
`objectRefs`	`ChatObjectRefDto[]`	–
`objectRefs[].type`Pflicht	`string`	Werte: `taskwiki_pageplanboardasset_objectfe_node`
`objectRefs[].id`Pflicht	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"bodyHtml":"…"}'

Delete a message (author or organization admin)#

DELETE/chat/messages/{messageId}Token

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Pin a message for everyone in the conversation#

PUT/chat/messages/{messageId}/pinToken

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}/pin" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Unpin a message#

DELETE/chat/messages/{messageId}/pinToken

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}/pin" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add my reaction#

PUT/chat/messages/{messageId}/reactions/{emoji}Token

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–
`emoji`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}/reactions/{emoji}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Remove my reaction#

DELETE/chat/messages/{messageId}/reactions/{emoji}Token

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–
`emoji`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}/reactions/{emoji}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Edit history of a message, oldest first#

GET/chat/messages/{messageId}/versionsToken

Parameter

Name	Ort	Typ	Beschreibung
`messageId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/messages/{messageId}/versions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Short-lived Realtime JWT for my inbox topic and the conversations I can read#

POST/chat/realtime/tokenToken

Request-Body`application/jsonChatRealtimeTokenDto`

Name	Typ	Beschreibung
`conversationIds`	`string[]`	Conversations to subscribe to; ones you cannot read are dropped

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/realtime/token" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"conversationIds":[]}'

Resolve task / wiki page refs into object cards I may see#

POST/chat/refs/resolveToken

Request-Body`application/jsonResolveChatRefsDto`

Name	Typ	Beschreibung
`refs`Pflicht	`ChatObjectRefDto[]`	–
`refs[].type`Pflicht	`string`	Werte: `taskwiki_pageplanboardasset_objectfe_node`
`refs[].id`Pflicht	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/chat/refs/resolve" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"refs":[]}'

Search messages in the conversations I can read#

GET/chat/searchToken

Parameter

Name	Ort	Typ	Beschreibung
`q`Pflicht	Query	`string`	–
`conversationId`	Query	`string`	–
`authorId`	Query	`string`	–
`from`	Query	`string`	–
`to`	Query	`string`	–
`limit`	Query	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/search" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

The channel of a space (created on first use)#

GET/chat/spaces/{spaceId}/channelToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/chat/spaces/{spaceId}/channel" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Chat

Inbox: my conversations with unread counts and previews#

Antworten

Conversation details, my state and members#

Parameter

Antworten

Rename a group or change its description (owners)#

Parameter

Request-Bodyapplication/jsonUpdateConversationDto

Antworten

Leave a group#

Parameter

Antworten

My notification level, mute and inbox pin#

Parameter

Request-Bodyapplication/jsonUpdateMyConversationStateDto

Antworten

Add people to a group#

Parameter

Request-Bodyapplication/jsonAddMembersDto

Antworten

Promote or demote a group member (owners)#

Parameter

Request-Bodyapplication/jsonSetMemberRoleDto

Antworten

Remove someone from a group (owners)#

Parameter

Antworten

A page of the timeline (or of one thread), ordered by seq#

Parameter

Antworten

Send a message (resending the same id is idempotent)#

Parameter

Request-Bodyapplication/jsonSendMessageDto

Antworten

Set my read position (markUnread moves it back)#

Parameter

Request-Bodyapplication/jsonMarkReadDto

Antworten

Open (or create) the direct message with a colleague#

Request-Bodyapplication/jsonCreateDmDto

Antworten

Create a group chat (you become its owner)#

Request-Bodyapplication/jsonCreateGroupDto

Antworten

Edit my message (every version is kept)#

Parameter

Request-Bodyapplication/jsonEditMessageDto

Antworten

Delete a message (author or organization admin)#

Parameter

Antworten

Pin a message for everyone in the conversation#

Parameter

Antworten

Unpin a message#

Parameter

Antworten

Add my reaction#

Parameter

Antworten

Remove my reaction#

Parameter

Antworten

Edit history of a message, oldest first#

Parameter

Antworten

Short-lived Realtime JWT for my inbox topic and the conversations I can read#

Request-Bodyapplication/jsonChatRealtimeTokenDto

Antworten

Resolve task / wiki page refs into object cards I may see#

Request-Bodyapplication/jsonResolveChatRefsDto

Antworten

Search messages in the conversations I can read#

Parameter

Antworten

The channel of a space (created on first use)#

Parameter

Antworten

Request-Body`application/jsonUpdateConversationDto`

Request-Body`application/jsonUpdateMyConversationStateDto`

Request-Body`application/jsonAddMembersDto`

Request-Body`application/jsonSetMemberRoleDto`

Request-Body`application/jsonSendMessageDto`

Request-Body`application/jsonMarkReadDto`

Request-Body`application/jsonCreateDmDto`

Request-Body`application/jsonCreateGroupDto`

Request-Body`application/jsonEditMessageDto`

Request-Body`application/jsonChatRealtimeTokenDto`

Request-Body`application/jsonResolveChatRefsDto`