Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
}
],
"responses": {
"201": {
"200": {
"description": "Request successful."
},
"401": {
Expand Down Expand Up @@ -680,46 +680,40 @@
"nextLinkName": "nextLink",
"itemName": "value"
}
},
"post": {
}
},
"/chat/threads/{chatThreadId}/participants/{chatParticipantId}": {
"delete": {
"tags": [
"Participants"
],
"summary": "Adds thread participants to a thread. If participants already exist, no change occurs.",
"operationId": "ChatThread_AddChatParticipants",
"consumes": [
"application/json"
],
"summary": "Remove a participant from a thread.",
"operationId": "ChatThread_RemoveChatParticipant",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "chatThreadId",
"description": "Id of the thread to add participants to.",
"description": "Thread id to remove the participant from.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ApiVersionParameter"
"in": "path",
"name": "chatParticipantId",
"description": "Id of the thread participant to remove from the thread.",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "addChatParticipantsRequest",
"description": "Thread participants to be added to the thread.",
"required": true,
"schema": {
"$ref": "#/definitions/AddChatParticipantsRequest"
}
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "The participants were successfully added.",
"schema": {
"$ref": "#/definitions/AddChatParticipantsResult"
}
"204": {
"description": "Request successful."
},
"401": {
"description": "Unauthorized.",
Expand Down Expand Up @@ -751,44 +745,52 @@
}
},
"x-ms-examples": {
"Add participants": {
"$ref": "./examples/Participants_AddChatParticipants.json"
"Remove participant": {
"$ref": "./examples/Participants_RemoveChatParticipant.json"
}
}
}
},
"/chat/threads/{chatThreadId}/participants/{chatParticipantId}": {
"delete": {
"/chat/threads/{chatThreadId}/participants/:add": {
"post": {
"tags": [
"Participants"
],
"summary": "Remove a participant from a thread.",
"operationId": "ChatThread_RemoveChatParticipant",
"summary": "Adds thread participants to a thread. If participants already exist, no change occurs.",
"operationId": "ChatThread_AddChatParticipants",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "chatThreadId",
"description": "Thread id to remove the participant from.",
"description": "Id of the thread to add participants to.",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "chatParticipantId",
"description": "Id of the thread participant to remove from the thread.",
"required": true,
"type": "string"
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
"in": "body",
"name": "addChatParticipantsRequest",
"description": "Thread participants to be added to the thread.",
"required": true,
"schema": {
"$ref": "#/definitions/AddChatParticipantsRequest"
}
}
],
"responses": {
"204": {
"description": "Request successful."
"201": {
"description": "The participants were successfully added.",
"schema": {
"$ref": "#/definitions/AddChatParticipantsResult"
}
},
"401": {
"description": "Unauthorized.",
Expand Down Expand Up @@ -820,8 +822,8 @@
}
},
"x-ms-examples": {
"Remove participant": {
"$ref": "./examples/Participants_RemoveChatParticipant.json"
"Add participants": {
"$ref": "./examples/Participants_AddChatParticipants.json"
}
}
}
Expand Down Expand Up @@ -1268,8 +1270,8 @@
"ChatMessagePriority": {
"description": "The chat message priority.",
"enum": [
"Normal",
"High"
"normal",
"high"
],
"type": "string",
"x-ms-enum": {
Expand Down Expand Up @@ -1311,6 +1313,74 @@
}
}
},
"ChatMessageType": {
"description": "The chat message type.",
"enum": [
"text",
"html",
"topicUpdated",
"participantAdded",
"participantRemoved"
],
"type": "string",
"x-ms-enum": {
"name": "ChatMessageType",
"modelAsString": true
}
},
"ChatParticipant": {
"description": "A participant of the chat thread.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "The id of the chat participant.",
"type": "string",
"example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
},
"displayName": {
"description": "Display name for the chat participant.",
"type": "string",
"example": "Bob"
},
"shareHistoryTime": {
"format": "date-time",
"description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2020-10-30T10:50:50Z"
}
}
},
"ChatMessageContent": {
"description": "Content of a chat message.",
"type": "object",
"properties": {
"message": {
"description": "Chat message content for type \"text\" or \"html\" messages.",
"type": "string",
"example": "Come one guys, lets go for lunch together."
},
"topic": {
"description": "Chat message content for type \"topicUpdated\" messages.",
"type": "string",
"example": "Lunch Chat thread"
},
"participants": {
"description": "Chat message content for type \"participantAdded\" or \"participantRemoved\" messages.",
"type": "array",
"items": {
"$ref": "#/definitions/ChatParticipant"
}
},
"initiator": {
"description": "Chat message content for type \"participantAdded\" or \"participantRemoved\" messages.",
"type": "string",
"example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
}
}
},
"ChatMessage": {
"description": "Chat message.",
"type": "object",
Expand All @@ -1322,9 +1392,7 @@
"example": "123456789"
},
"type": {
"description": "Type of the chat message.\r\n \r\nPossible values:\r\n - Text\r\n - ThreadActivity/TopicUpdate\r\n - ThreadActivity/AddMember\r\n - ThreadActivity/DeleteMember",
"type": "string",
"example": "Text"
"$ref": "#/definitions/ChatMessageType"
},
"priority": {
"$ref": "#/definitions/ChatMessagePriority"
Expand All @@ -1335,9 +1403,7 @@
"readOnly": true
},
"content": {
"description": "Content of the chat message.",
"type": "string",
"example": "Come one guys, lets go for lunch together."
"$ref": "#/definitions/ChatMessageContent"
},
"senderDisplayName": {
"description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.",
Expand Down Expand Up @@ -1404,31 +1470,6 @@
}
}
},
"ChatParticipant": {
"description": "A participant of the chat thread.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "The id of the chat participant.",
"type": "string",
"example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
},
"displayName": {
"description": "Display name for the chat participant.",
"type": "string",
"example": "Bob"
},
"shareHistoryTime": {
"format": "date-time",
"description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
"type": "string",
"example": "2020-10-30T10:50:50Z"
}
}
},
"ChatParticipantsCollection": {
"description": "Collection of participants belong to a particular thread.",
"type": "object",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"endpoint": "https://contoso.westus.communications.azure.com",
"api-version": "2020-11-01-preview3",
"chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
"$maxpagesize": 2
"maxPageSize": 2
},
"responses": {
"200": {
Expand All @@ -20,7 +20,7 @@
"readOn": "2020-06-06T05:55:41.6460000Z"
}
],
"nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&$maxpagesize=2&api-version=2020-11-01-preview3"
"nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2020-11-01-preview3"
}
},
"401": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
}
},
"responses": {
"201": {},
"200": {},
"401": {
"body": {
"code": "Unauthorized",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@
"200": {
"body": {
"id": "1591768249318",
"type": "Text",
"type": "text",
"version": "1599016601134",
"priority": "Normal",
"content": "Let's head out for lunch in 15 minutes.",
"priority": "normal",
"content": {
"message": "Let's head out for lunch in 15 minutes."
},
"senderDisplayName": "Jane",
"createdOn": "2020-06-10T05:50:49.3180000Z",
"senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
Expand Down
Loading