Skip to content

Commit 0dd49a4

Browse files
jiriburantjiriburant
authored
Communication.Common Added new MS Teams app identifier (#26681)
* New API version 2023-11-15-stable * Added new MS Teams application identifier for integration with Teams voice apps. * Changed the default api version of communication common api definition.
1 parent ed825a1 commit 0dd49a4

File tree

2 files changed

+203
-1
lines changed

2 files changed

+203
-1
lines changed

‎specification/communication/data-plane/Common/readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ These are the global settings for the communicationservices.
2626

2727
```yaml
2828
openapi-type: data-plane
29-
tag: package-2020-07-20-preview1
29+
tag: package-2023-11-15-stable
3030
```
3131
3232
@@ -55,6 +55,14 @@ input-file:
5555
- stable/2022-07-13/common.json
5656
```
5757

58+
### Tag: package-2023-11-15-stable
59+
These settings apply only when `--tag=package-2023-11-15-stable` is specified on the command line.
60+
61+
```yaml $(tag) == 'package-2023-11-15-stable'
62+
input-file:
63+
- stable/2023-11-15/common.json
64+
```
65+
5866
---
5967

6068
# Code Generation

‎specification/communication/data-plane/Common/stable/2023-11-15/common.json

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "Communication",
5+
"description": "Communication Services API common types.",
6+
"version": "2023-11-15"
7+
},
8+
"paths": {},
9+
"definitions": {
10+
"CommunicationErrorResponse": {
11+
"description": "The Communication Services error.",
12+
"type": "object",
13+
"required": [
14+
"error"
15+
],
16+
"properties": {
17+
"error": {
18+
"description": "The Communication Services error.",
19+
"$ref": "#/definitions/CommunicationError"
20+
}
21+
}
22+
},
23+
"CommunicationError": {
24+
"description": "The Communication Services error.",
25+
"type": "object",
26+
"required": [
27+
"code",
28+
"message"
29+
],
30+
"properties": {
31+
"code": {
32+
"type": "string",
33+
"description": "The error code."
34+
},
35+
"message": {
36+
"type": "string",
37+
"description": "The error message."
38+
},
39+
"target": {
40+
"type": "string",
41+
"readOnly": true,
42+
"description": "The error target."
43+
},
44+
"details": {
45+
"type": "array",
46+
"items": {
47+
"$ref": "#/definitions/CommunicationError"
48+
},
49+
"readOnly": true,
50+
"description": "Further details about specific errors that led to this error."
51+
},
52+
"innererror": {
53+
"x-ms-client-name": "innerError",
54+
"readOnly": true,
55+
"$ref": "#/definitions/CommunicationError",
56+
"description": "The inner error if any."
57+
}
58+
}
59+
},
60+
"CommunicationCloudEnvironmentModel": {
61+
"description": "The cloud that the identifier belongs to.",
62+
"type": "string",
63+
"enum": [
64+
"public",
65+
"dod",
66+
"gcch"
67+
],
68+
"x-ms-enum": {
69+
"name": "CommunicationCloudEnvironmentModel",
70+
"modelAsString": true
71+
}
72+
},
73+
"CommunicationIdentifierModelKind": {
74+
"description": "The identifier kind, for example 'communicationUser' or 'phoneNumber'.",
75+
"type": "string",
76+
"enum": [
77+
"unknown",
78+
"communicationUser",
79+
"phoneNumber",
80+
"microsoftTeamsUser",
81+
"microsoftTeamsApp"
82+
],
83+
"x-ms-enum": {
84+
"name": "CommunicationIdentifierModelKind",
85+
"modelAsString": true
86+
}
87+
},
88+
"CommunicationIdentifierModel": {
89+
"description": "Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.",
90+
"type": "object",
91+
"properties": {
92+
"kind": {
93+
"$ref": "#/definitions/CommunicationIdentifierModelKind",
94+
"description": "The identifier kind. Only required in responses."
95+
},
96+
"rawId": {
97+
"type": "string",
98+
"description": "Raw Id of the identifier. Optional in requests, required in responses."
99+
},
100+
"communicationUser": {
101+
"$ref": "#/definitions/CommunicationUserIdentifierModel",
102+
"description": "The communication user."
103+
},
104+
"phoneNumber": {
105+
"$ref": "#/definitions/PhoneNumberIdentifierModel",
106+
"description": "The phone number."
107+
},
108+
"microsoftTeamsUser": {
109+
"$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel",
110+
"description": "The Microsoft Teams user."
111+
},
112+
"microsoftTeamsApp": {
113+
"$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel",
114+
"description": "The Microsoft Teams application."
115+
}
116+
}
117+
},
118+
"CommunicationUserIdentifierModel": {
119+
"description": "A user that got created with an Azure Communication Services resource.",
120+
"type": "object",
121+
"required": [
122+
"id"
123+
],
124+
"properties": {
125+
"id": {
126+
"type": "string",
127+
"description": "The Id of the communication user."
128+
}
129+
}
130+
},
131+
"PhoneNumberIdentifierModel": {
132+
"description": "A phone number.",
133+
"type": "object",
134+
"required": [
135+
"value"
136+
],
137+
"properties": {
138+
"value": {
139+
"type": "string",
140+
"description": "The phone number in E.164 format."
141+
}
142+
}
143+
},
144+
"MicrosoftTeamsUserIdentifierModel": {
145+
"description": "A Microsoft Teams user.",
146+
"type": "object",
147+
"required": [
148+
"userId"
149+
],
150+
"properties": {
151+
"userId": {
152+
"type": "string",
153+
"description": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
154+
},
155+
"isAnonymous": {
156+
"type": "boolean",
157+
"description": "True if the Microsoft Teams user is anonymous. By default false if missing."
158+
},
159+
"cloud": {
160+
"$ref": "#/definitions/CommunicationCloudEnvironmentModel",
161+
"description": "The cloud that the Microsoft Teams user belongs to. By default 'public' if missing."
162+
}
163+
}
164+
},
165+
"MicrosoftTeamsAppIdentifierModel": {
166+
"description": "A Microsoft Teams application.",
167+
"type": "object",
168+
"required": [
169+
"appId"
170+
],
171+
"properties": {
172+
"appId": {
173+
"type": "string",
174+
"description": "The Id of the Microsoft Teams application."
175+
},
176+
"cloud": {
177+
"$ref": "#/definitions/CommunicationCloudEnvironmentModel",
178+
"description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing."
179+
}
180+
}
181+
}
182+
},
183+
"securityDefinitions": {
184+
"azure_auth": {
185+
"type": "oauth2",
186+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
187+
"flow": "implicit",
188+
"description": "Azure Active Directory OAuth2 Flow.",
189+
"scopes": {
190+
"user_impersonation": "impersonate your user account"
191+
}
192+
}
193+
}
194+
}

0 commit comments

Comments
 (0)