Skip to content

Commit fc59c63

Browse files
pohtsngPo Tsang
pohtsng
and
Po Tsang
authored
Add specs for ACS Chat preview7 (#16887)
* Baseline using previous API version * Updates for preview7 * Update readme.md * Prettier fix * Fix readme * Fix example for update-participant Co-authored-by: Po Tsang <tsangpo@microsoft.com>
1 parent 322d0ed commit fc59c63

20 files changed

+3084
-0
lines changed

‎specification/communication/data-plane/Chat/preview/2021-10-01-preview7/communicationserviceschat.json‎

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

‎specification/communication/data-plane/Chat/preview/2021-10-01-preview7/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": "2021-10-01-preview7",
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:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2021-10-01-preview7"
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/2021-10-01-preview7/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": "2021-10-01-preview7",
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/2021-10-01-preview7/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": "2021-10-01-preview7",
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/2021-10-01-preview7/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": "2021-10-01-preview7",
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+
}

‎specification/communication/data-plane/Chat/preview/2021-10-01-preview7/examples/Messages_ListChatMessagesWithPageSize.json‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://contoso.westus.communications.azure.com",
4+
"api-version": "2021-10-01-preview7",
5+
"chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2",
6+
"maxPageSize": 5
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"id": "1593107077690",
14+
"type": "text",
15+
"version": "1593107077683",
16+
"sequenceId": "5",
17+
"content": {
18+
"message": "So where should we get lunch from today?"
19+
},
20+
"senderDisplayName": "Jane",
21+
"createdOn": "2020-06-25T17:44:37.6830000Z",
22+
"senderCommunicationIdentifier": {
23+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
24+
"communicationUser": {
25+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
26+
}
27+
}
28+
},
29+
{
30+
"id": "1593107077683",
31+
"type": "text",
32+
"sequenceId": "4",
33+
"version": "1593107077683",
34+
"content": {
35+
"message": "Let's use this chat to decide what to get for lunch today."
36+
},
37+
"senderDisplayName": "Jane",
38+
"createdOn": "2020-06-25T17:44:37.6830000Z",
39+
"senderCommunicationIdentifier": {
40+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
41+
"communicationUser": {
42+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
43+
}
44+
}
45+
},
46+
{
47+
"id": "1593107046498",
48+
"type": "text",
49+
"sequenceId": "3",
50+
"version": "1593107046498",
51+
"content": {
52+
"message": "Good morning everyone!"
53+
},
54+
"senderDisplayName": "Jane",
55+
"createdOn": "2020-06-25T17:44:06.4980000Z",
56+
"senderCommunicationIdentifier": {
57+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
58+
"communicationUser": {
59+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
60+
}
61+
}
62+
},
63+
{
64+
"id": "1593106976785",
65+
"type": "topicUpdated",
66+
"sequenceId": "2",
67+
"version": "1593106976785",
68+
"content": {
69+
"initiatorCommunicationIdentifier": {
70+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
71+
"communicationUser": {
72+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
73+
}
74+
},
75+
"topic": "Lunch"
76+
},
77+
"createdOn": "2020-06-25T17:42:56.7850000Z"
78+
},
79+
{
80+
"id": "1593106976753",
81+
"type": "participantAdded",
82+
"version": "1593106976753",
83+
"sequenceId": "1",
84+
"content": {
85+
"initiatorCommunicationIdentifier": {
86+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
87+
"communicationUser": {
88+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
89+
}
90+
},
91+
"participants": [
92+
{
93+
"communicationIdentifier": {
94+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
95+
"communicationUser": {
96+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
97+
}
98+
},
99+
"roleIds": [
100+
"8540c0de-899f-5cce-acb5-3ec493af3800_ce2142fd-aa87-435d-bacf-16efe5ae70aa"
101+
]
102+
},
103+
{
104+
"communicationIdentifier": {
105+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
106+
"communicationUser": {
107+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
108+
}
109+
},
110+
"roleIds": [
111+
"8540c0de-899f-5cce-acb5-3ec493af3800_ce2142fd-aa87-435d-bacf-16efe5ae70aa"
112+
]
113+
},
114+
{
115+
"communicationIdentifier": {
116+
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
117+
"communicationUser": {
118+
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
119+
}
120+
},
121+
"roleIds": [
122+
"8540c0de-899f-5cce-acb5-3ec493af3800_ce2142fd-aa87-435d-bacf-16efe5ae70aa"
123+
]
124+
}
125+
]
126+
},
127+
"createdOn": "2020-06-25T17:42:56.7530000Z"
128+
}
129+
],
130+
"nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2021-10-01-preview7"
131+
}
132+
},
133+
"401": {
134+
"body": {
135+
"error": {
136+
"code": "Unauthorized",
137+
"message": "Request is not authorized."
138+
}
139+
}
140+
},
141+
"403": {
142+
"body": {
143+
"error": {
144+
"code": "Forbidden",
145+
"message": "User is not allowed to perform specified action."
146+
}
147+
}
148+
},
149+
"429": {
150+
"body": {
151+
"error": {
152+
"code": "TooManyRequests",
153+
"message": "Rate limit exceeded."
154+
}
155+
}
156+
},
157+
"503": {
158+
"body": {
159+
"error": {
160+
"code": "ServiceUnavailable",
161+
"message": "The server is currently unable to handle the request."
162+
}
163+
}
164+
}
165+
}
166+
}

0 commit comments

Comments
 (0)