-
Notifications
You must be signed in to change notification settings - Fork 5k
/
communicationservicessiprouting.json
264 lines (264 loc) · 7.38 KB
/
communicationservicessiprouting.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
{
"swagger": "2.0",
"info": {
"title": "SipRouting Service",
"description": "SipRouting Service",
"contact": {
"email": "acsdevexdisc@microsoft.com"
},
"version": "2023-03-01"
},
"paths": {
"/sip": {
"get": {
"tags": [
"SipConfiguration"
],
"summary": "Gets SIP configuration for resource.",
"operationId": "SipRouting_Get",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Ok.",
"schema": {
"$ref": "#/definitions/SipConfiguration"
}
},
"default": {
"description": "Failure",
"schema": {
"$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code"
}
}
}
},
"x-ms-examples": {
"Get SIP configuration for resource": {
"$ref": "./examples/GetSipConfiguration.json"
}
}
},
"patch": {
"tags": [
"SipConfiguration"
],
"summary": "Updates SIP configuration for resource.",
"operationId": "SipRouting_Update",
"consumes": [
"application/merge-patch+json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Sip configuration update object.",
"schema": {
"$ref": "#/definitions/SipConfigurationUpdate"
}
}
],
"responses": {
"200": {
"description": "Updated configuration is returned.",
"schema": {
"$ref": "#/definitions/SipConfiguration"
}
},
"default": {
"description": "Failure",
"schema": {
"$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "Error code"
}
}
}
},
"x-ms-examples": {
"Update SIP configuration for resource": {
"$ref": "./examples/UpdateSipConfiguration.json"
}
}
}
}
},
"definitions": {
"Trunk": {
"description": "Represents a SIP trunk for routing calls. See RFC 4904.",
"required": [
"sipSignalingPort"
],
"type": "object",
"properties": {
"sipSignalingPort": {
"format": "int32",
"description": "Gets or sets SIP signaling port of the trunk.",
"type": "integer"
}
}
},
"TrunkUpdate": {
"description": "Represents a SIP trunk update.",
"type": "object",
"properties": {
"sipSignalingPort": {
"format": "int32",
"description": "Gets or sets SIP signaling port of the trunk.",
"type": "integer"
}
}
},
"TrunkRoute": {
"description": "Represents a trunk route for routing calls.",
"required": [
"name",
"numberPattern"
],
"type": "object",
"properties": {
"description": {
"description": "Gets or sets description of the route.",
"maxLength": 1024,
"type": "string"
},
"name": {
"description": "Gets or sets name of the route.",
"maxLength": 256,
"type": "string"
},
"numberPattern": {
"description": "Gets or sets regex number pattern for routing calls. .NET regex format is supported.\r\nThe regex should match only digits with an optional '+' prefix without spaces.\r\nI.e. \"^\\+[1-9][0-9]{3,23}$\".",
"maxLength": 1024,
"type": "string"
},
"trunks": {
"description": "Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN.",
"maxItems": 250,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SipConfiguration": {
"description": "Represents a SIP configuration.\r\nWhen a call is being routed the routes are applied in the same order as in the routes list.\r\nA route is matched by its number pattern.\r\nCall is then directed into route's first available trunk, based on the order in the route's trunks list.",
"type": "object",
"properties": {
"trunks": {
"description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).",
"maxProperties": 250,
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Trunk"
}
},
"routes": {
"description": "Trunk routes for routing calls.",
"maxItems": 250,
"type": "array",
"items": {
"$ref": "#/definitions/TrunkRoute"
}
}
}
},
"SipConfigurationUpdate": {
"description": "Represents a SIP configuration update.",
"type": "object",
"properties": {
"trunks": {
"description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).",
"maxProperties": 250,
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/TrunkUpdate"
}
},
"routes": {
"description": "Trunk routes for routing calls.",
"maxItems": 250,
"type": "array",
"items": {
"$ref": "#/definitions/TrunkRoute"
}
}
}
}
},
"parameters": {
"ApiVersionParameter": {
"in": "query",
"name": "api-version",
"description": "Version of API to invoke",
"required": true,
"type": "string"
},
"Endpoint": {
"in": "path",
"name": "endpoint",
"description": "The communication resource, for example https://resourcename.communication.azure.com",
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"description": "Azure Active Directory OAuth2 Flow"
},
"apiKey": {
"type": "apiKey",
"name": "access_key",
"in": "header",
"description": "An authentication string containing a signature generated using HMAC-SHA256 scheme."
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
},
{
"apiKey": []
}
],
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
]
}
}