Skip to content

Commit 0d5a422

Browse files
jimchou-devjimchou-dev
authored
[ACS][Communication][Chat] 2024-06-05-preview public preview API spec (Azure#28875)
1 parent b22c642 commit 0d5a422

22 files changed

+3483
-0
lines changed

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/communicationserviceschat.json

Lines changed: 2209 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_ListChatReadReceiptsWithPageSize.json

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
6+
"maxPageSize": 2
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"senderCommunicationIdentifier": {
14+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
15+
"communicationUser": {
16+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
17+
}
18+
},
19+
"chatMessageId": "1591137790240",
20+
"readOn": "2020-06-06T05:55:41.6460000Z"
21+
},
22+
{
23+
"senderCommunicationIdentifier": {
24+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
25+
"communicationUser": {
26+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
27+
}
28+
},
29+
"chatMessageId": "1591768249318",
30+
"readOn": "2020-06-06T05:55:41.6460000Z"
31+
}
32+
],
33+
"nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:[email protected]/readReceipts?skip=2&maxPageSize=2&api-version=2024-06-05-preview"
34+
}
35+
},
36+
"401": {
37+
"body": {
38+
"error": {
39+
"code": "Unauthorized",
40+
"message": "Request is not authorized."
41+
}
42+
}
43+
},
44+
"403": {
45+
"body": {
46+
"error": {
47+
"code": "Forbidden",
48+
"message": "User is not allowed to perform specified action."
49+
}
50+
}
51+
},
52+
"429": {
53+
"body": {
54+
"error": {
55+
"code": "TooManyRequests",
56+
"message": "Rate limit exceeded."
57+
}
58+
}
59+
},
60+
"503": {
61+
"body": {
62+
"error": {
63+
"code": "ServiceUnavailable",
64+
"message": "The server is currently unable to handle the request."
65+
}
66+
}
67+
}
68+
}
69+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Conversations_SendChatReadReceipt.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
6+
"sendReadReceiptRequest": {
7+
"chatMessageId": "1591137790240"
8+
}
9+
},
10+
"responses": {
11+
"200": {},
12+
"401": {
13+
"body": {
14+
"error": {
15+
"code": "Unauthorized",
16+
"message": "Request is not authorized."
17+
}
18+
}
19+
},
20+
"403": {
21+
"body": {
22+
"error": {
23+
"code": "Forbidden",
24+
"message": "User is not allowed to perform specified action."
25+
}
26+
}
27+
},
28+
"429": {
29+
"body": {
30+
"error": {
31+
"code": "TooManyRequests",
32+
"message": "Rate limit exceeded."
33+
}
34+
}
35+
},
36+
"503": {
37+
"body": {
38+
"error": {
39+
"code": "ServiceUnavailable",
40+
"message": "The server is currently unable to handle the request."
41+
}
42+
}
43+
}
44+
}
45+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_DeleteChatImage.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "19:[email protected]",
6+
"imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433"
7+
},
8+
"responses": {
9+
"204": {}
10+
}
11+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_GetChatImage.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "19:[email protected]",
6+
"imageId": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433",
7+
"imageViewType": "original"
8+
},
9+
"responses": {
10+
"200": {
11+
"headers": {
12+
"Content-Type": "image/png"
13+
},
14+
"body": "{binary}"
15+
}
16+
}
17+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Images_UploadChatImage.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "19:[email protected]",
6+
"chatImageFile": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAAAAAA6fptVAAAACklEQVQYV2P4DwABAQEAWk1v8QAAAABJRU5ErkJggg==",
7+
"image-filename": "sample.png"
8+
},
9+
"responses": {
10+
"201": {
11+
"headers": {
12+
"Location": "/chat/threads/19:[email protected]/images/0-eus-d2-fb42e272282ebb6ef76a3aedd1974433"
13+
},
14+
"body": {
15+
"id": "0-eus-d2-fb42e272282ebb6ef76a3aedd1974433",
16+
"attachmentType": "inlineImage",
17+
"name": "sample.png"
18+
}
19+
}
20+
}
21+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_DeleteChatMessage.json

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
6+
"chatMessageId": "1591768249318"
7+
},
8+
"responses": {
9+
"204": {},
10+
"401": {
11+
"body": {
12+
"error": {
13+
"code": "Unauthorized",
14+
"message": "Request is not authorized."
15+
}
16+
}
17+
},
18+
"403": {
19+
"body": {
20+
"error": {
21+
"code": "Forbidden",
22+
"message": "User is not allowed to perform specified action."
23+
}
24+
}
25+
},
26+
"429": {
27+
"body": {
28+
"error": {
29+
"code": "TooManyRequests",
30+
"message": "Rate limit exceeded."
31+
}
32+
}
33+
},
34+
"503": {
35+
"body": {
36+
"error": {
37+
"code": "ServiceUnavailable",
38+
"message": "The server is currently unable to handle the request."
39+
}
40+
}
41+
}
42+
}
43+
}

‎specification/communication/data-plane/Chat/preview/2024-06-05-preview/examples/Messages_GetChatMessage.json

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2024-06-05-preview",
5+
"chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
6+
"chatMessageId": "1591768249318"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"id": "1591768249318",
12+
"sequenceId": "1",
13+
"type": "text",
14+
"version": "1599016601134",
15+
"content": {
16+
"message": "Let's head out for lunch in 15 minutes."
17+
},
18+
"senderDisplayName": "Jane",
19+
"createdOn": "2020-06-10T05:50:49.3180000Z",
20+
"senderCommunicationIdentifier": {
21+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
22+
"communicationUser": {
23+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
24+
}
25+
},
26+
"metadata": {
27+
"someKey1": "someValue1",
28+
"someKey2": "someValue2"
29+
}
30+
}
31+
},
32+
"401": {
33+
"body": {
34+
"error": {
35+
"code": "Unauthorized",
36+
"message": "Request is not authorized."
37+
}
38+
}
39+
},
40+
"403": {
41+
"body": {
42+
"error": {
43+
"code": "Forbidden",
44+
"message": "User is not allowed to perform specified action."
45+
}
46+
}
47+
},
48+
"429": {
49+
"body": {
50+
"error": {
51+
"code": "TooManyRequests",
52+
"message": "Rate limit exceeded."
53+
}
54+
}
55+
},
56+
"503": {
57+
"body": {
58+
"error": {
59+
"code": "ServiceUnavailable",
60+
"message": "The server is currently unable to handle the request."
61+
}
62+
}
63+
}
64+
}
65+
}

0 commit comments

Comments
 (0)