-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ACS][Communication][Chat] 2024-06-05-preview public preview API spec (…
- Loading branch information
1 parent
b22c642
commit 0d5a422
Showing
22 changed files
with
3,483 additions
and
0 deletions.
There are no files selected for viewing
2,209 changes: 2,209 additions & 0 deletions
2,209
...n/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json
Large diffs are not rendered by default.
Oops, something went wrong.
69 changes: 69 additions & 0 deletions
69
...t/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", | ||
"maxPageSize": 2 | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"value": [ | ||
{ | ||
"senderCommunicationIdentifier": { | ||
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", | ||
"communicationUser": { | ||
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" | ||
} | ||
}, | ||
"chatMessageId": "1591137790240", | ||
"readOn": "2020-06-06T05:55:41.6460000Z" | ||
}, | ||
{ | ||
"senderCommunicationIdentifier": { | ||
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", | ||
"communicationUser": { | ||
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" | ||
} | ||
}, | ||
"chatMessageId": "1591768249318", | ||
"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=2024-06-05-preview" | ||
} | ||
}, | ||
"401": { | ||
"body": { | ||
"error": { | ||
"code": "Unauthorized", | ||
"message": "Request is not authorized." | ||
} | ||
} | ||
}, | ||
"403": { | ||
"body": { | ||
"error": { | ||
"code": "Forbidden", | ||
"message": "User is not allowed to perform specified action." | ||
} | ||
} | ||
}, | ||
"429": { | ||
"body": { | ||
"error": { | ||
"code": "TooManyRequests", | ||
"message": "Rate limit exceeded." | ||
} | ||
} | ||
}, | ||
"503": { | ||
"body": { | ||
"error": { | ||
"code": "ServiceUnavailable", | ||
"message": "The server is currently unable to handle the request." | ||
} | ||
} | ||
} | ||
} | ||
} |
45 changes: 45 additions & 0 deletions
45
...ata-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", | ||
"sendReadReceiptRequest": { | ||
"chatMessageId": "1591137790240" | ||
} | ||
}, | ||
"responses": { | ||
"200": {}, | ||
"401": { | ||
"body": { | ||
"error": { | ||
"code": "Unauthorized", | ||
"message": "Request is not authorized." | ||
} | ||
} | ||
}, | ||
"403": { | ||
"body": { | ||
"error": { | ||
"code": "Forbidden", | ||
"message": "User is not allowed to perform specified action." | ||
} | ||
} | ||
}, | ||
"429": { | ||
"body": { | ||
"error": { | ||
"code": "TooManyRequests", | ||
"message": "Rate limit exceeded." | ||
} | ||
} | ||
}, | ||
"503": { | ||
"body": { | ||
"error": { | ||
"code": "ServiceUnavailable", | ||
"message": "The server is currently unable to handle the request." | ||
} | ||
} | ||
} | ||
} | ||
} |
11 changes: 11 additions & 0 deletions
11
...unication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", | ||
"imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433" | ||
}, | ||
"responses": { | ||
"204": {} | ||
} | ||
} |
17 changes: 17 additions & 0 deletions
17
...ommunication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", | ||
"imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433", | ||
"imageViewType": "original" | ||
}, | ||
"responses": { | ||
"200": { | ||
"headers": { | ||
"Content-Type": "image/png" | ||
}, | ||
"body": "{binary}" | ||
} | ||
} | ||
} |
21 changes: 21 additions & 0 deletions
21
...unication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", | ||
"chatImageFile": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVQYV2P4DwABAQEAWk1v8QAAAABJRU5ErkJggg==", | ||
"image-filename": "sample.png" | ||
}, | ||
"responses": { | ||
"201": { | ||
"headers": { | ||
"Location": "/chat/threads/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433" | ||
}, | ||
"body": { | ||
"id": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433", | ||
"attachmentType": "inlineImage", | ||
"name": "sample.png" | ||
} | ||
} | ||
} | ||
} |
43 changes: 43 additions & 0 deletions
43
...ation/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", | ||
"chatMessageId": "1591768249318" | ||
}, | ||
"responses": { | ||
"204": {}, | ||
"401": { | ||
"body": { | ||
"error": { | ||
"code": "Unauthorized", | ||
"message": "Request is not authorized." | ||
} | ||
} | ||
}, | ||
"403": { | ||
"body": { | ||
"error": { | ||
"code": "Forbidden", | ||
"message": "User is not allowed to perform specified action." | ||
} | ||
} | ||
}, | ||
"429": { | ||
"body": { | ||
"error": { | ||
"code": "TooManyRequests", | ||
"message": "Rate limit exceeded." | ||
} | ||
} | ||
}, | ||
"503": { | ||
"body": { | ||
"error": { | ||
"code": "ServiceUnavailable", | ||
"message": "The server is currently unable to handle the request." | ||
} | ||
} | ||
} | ||
} | ||
} |
65 changes: 65 additions & 0 deletions
65
...nication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
{ | ||
"parameters": { | ||
"endpoint": "https://contoso.westus.communications.azure.com", | ||
"api-version": "2024-06-05-preview", | ||
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", | ||
"chatMessageId": "1591768249318" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"id": "1591768249318", | ||
"sequenceId": "1", | ||
"type": "text", | ||
"version": "1599016601134", | ||
"content": { | ||
"message": "Let's head out for lunch in 15 minutes." | ||
}, | ||
"senderDisplayName": "Jane", | ||
"createdOn": "2020-06-10T05:50:49.3180000Z", | ||
"senderCommunicationIdentifier": { | ||
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", | ||
"communicationUser": { | ||
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" | ||
} | ||
}, | ||
"metadata": { | ||
"someKey1": "someValue1", | ||
"someKey2": "someValue2" | ||
} | ||
} | ||
}, | ||
"401": { | ||
"body": { | ||
"error": { | ||
"code": "Unauthorized", | ||
"message": "Request is not authorized." | ||
} | ||
} | ||
}, | ||
"403": { | ||
"body": { | ||
"error": { | ||
"code": "Forbidden", | ||
"message": "User is not allowed to perform specified action." | ||
} | ||
} | ||
}, | ||
"429": { | ||
"body": { | ||
"error": { | ||
"code": "TooManyRequests", | ||
"message": "Rate limit exceeded." | ||
} | ||
} | ||
}, | ||
"503": { | ||
"body": { | ||
"error": { | ||
"code": "ServiceUnavailable", | ||
"message": "The server is currently unable to handle the request." | ||
} | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.