Skip to Content
Last modified by ryanp on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The Asterisk conference room REST resource allows access to the configuration for conference rooms in the system. This resource allows adding, removing, and updating of conference rooms in the system.
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "066a6359-0ff1-49e5-83aa-52083dfbbddb",
41 "name": "Main",
42 "identifier": "650",
43 "destinationExtension": "650",
44 "destinationContext": "from-internal",
45 "permissionDisplayName": "Main <650>",
46 "permissionId": "066a6359-0ff1-49e5-83aa-52083dfbbddb"
47 }
48 {{/code}}
49
50 |=(((
51 Property
52 )))|=(((
53 Type
54 )))|=(((
55 Description
56 )))
57 |(((
58 {{{id}}}
59 )))|(((
60 String
61 )))|(((
62 Configuration id of the conference room.
63 )))
64 |(% colspan="1" %)(% colspan="1" %)
65 (((
66 {{{name}}}
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 String
70 )))|(% colspan="1" %)(% colspan="1" %)
71 (((
72 The display name of the conference room.
73 )))
74 |(% colspan="1" %)(% colspan="1" %)
75 (((
76 identifier
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 String
80 )))|(% colspan="1" %)(% colspan="1" %)
81 (((
82 The Asterisk identifier of the conference room.
83 )))
84 |(% colspan="1" %)(% colspan="1" %)
85 (((
86 {{{destinationExtension}}}
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 String
90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 The extension used to call the conference room from the panel.
93 )))
94 |(% colspan="1" %)(% colspan="1" %)
95 (((
96 {{{destinationContext}}}
97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
99 String
100 )))|(% colspan="1" %)(% colspan="1" %)
101 (((
102 The context used to call the conference room from the panel.
103 )))
104 |(% colspan="1" %)(% colspan="1" %)
105 (((
106 displayName
107 )))|(% colspan="1" %)(% colspan="1" %)
108 (((
109 String
110 )))|(% colspan="1" %)(% colspan="1" %)
111 (((
112 The display name for the user.
113 )))
114 |(% colspan="1" %)(% colspan="1" %)
115 (((
116 {{{permissionDisplayName}}}
117 )))|(% colspan="1" %)(% colspan="1" %)
118 (((
119 String
120 )))|(% colspan="1" %)(% colspan="1" %)
121 (((
122 Display name of the conference room in the permission system.
123 )))
124 |(% colspan="1" %)(% colspan="1" %)
125 (((
126 {{{permissionId}}}
127 )))|(% colspan="1" %)(% colspan="1" %)
128 (((
129 String
130 )))|(% colspan="1" %)(% colspan="1" %)
131 (((
132 Permission id of the conference room.
133 )))
134
135 = Resource Paths =
136
137 |=(% colspan="2" %)(% colspan="2" %)
138 (((
139 {{{communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms}}}
140 )))
141 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
142 (((
143 **Description**
144 )))|(((
145 Accesses all the conference rooms in the core server.
146 )))
147 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
148 (((
149 **GET**
150 )))|(((
151 Gets all the configuration for all the conference rooms in the system.
152 )))
153 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
154 (((
155 **POST
156 **
157 )))|(% colspan="1" %)(% colspan="1" %)
158 (((
159 Adds a conference room to the configuration.
160
161 (% style="line-height: 1.42857;" %)**Errors:**
162
163 * 409 'A conferenceRoom with the given id already exists.': Returned if a conference room with the given id already exists.
164 * 409 'A conferenceRoom with the given identifier already exists.': Returned if a conference room with the given identifier already exists.
165 * 412 'No identifier provided.': Returned if no identifier was provided.
166 * 412 'No name provided.': Returned if no name was provided.
167 * 412 'No destinationContext provided.': Returned if no destination context was provided.
168 * 412 'No destinationExtension provided.': Returned if no destination extension was provided.
169 )))
170 |(% colspan="2" %)(% colspan="2" %)
171 (((
172
173 )))
174 |=(% colspan="2" %)(% colspan="2" %)
175 (((
176 {{{communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms/{conferenceRoomId}}}}
177 )))
178 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
179 (((
180 **Description**
181 )))|(((
182 Accesses the configuration of a specific conference room.
183
184 **Parameters:**
185
186 * conferenceRoomId: The configuration id of the conference room.
187 )))
188 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
189 (((
190 **GET**
191 )))|(((
192 Gets the configuration of the specified conference room.
193
194 **Errors:**
195
196 * 404 'A conference room with the given id does not exist': Returned if no conference room exists with the given id.
197 )))
198 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
199 (((
200 **PUT**
201 )))|(% colspan="1" %)(% colspan="1" %)
202 (((
203 Updates the specified conference room configuration.
204
205 **Errors:**
206
207 * 404 'A conference room with the given id does not exist': Returned if no conference room exists with the given id.
208 * 409 'A conference room with the given identifier already exists.': Returned if a conference room with the given identifier already exists.
209 * 412 'No identifier provided.': Returned if no identifier was provided.
210 * 412 'No name provided.': Returned if no name was provided.
211 * 412 'No destinationContext provided.': Returned if no destination context was provided.
212 * 412 'No destinationExtension provided.': Returned if no destination extension was provided.
213 )))
214 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
215 (((
216 **DELETE**
217 )))|(% colspan="1" %)(% colspan="1" %)
218 (((
219 Deletes the specified conference room configuration.
220
221 **Errors:**
222
223 * 404 'A queue with the given id does not exist': Returned if no queue exists with the given id.
224 )))
225
226 = Curl Examples =
227
228 === Get all conference rooms in a core server ===
229
230 {{code language="bash"}}
231 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms
232 {{/code}}
233
234 === Get the configuration for a specific conference room ===
235
236 {{code language="bash"}}
237 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf
238 {{/code}}
239
240 === Add a new conference room ===
241
242 {{code language="bash"}}
243 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id":"066a6359-0ff1-49e5-83aa-52083dfbbddb","name":"Main","identifier":"650","destinationExtension":"650","destinationContext":"from-internal"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms
244 {{/code}}
245
246 === Delete a conference room ===
247
248 {{code language="bash"}}
249 curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf
250 {{/code}}
251
252 === Update a conference room ===
253
254 {{code language="bash"}}
255 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"066a6359-0ff1-49e5-83aa-52083dfbbddb","name":"Main New","identifier":"650","destinationExtension":"650","destinationContext":"from-internal"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf
256 {{/code}}
257 {{/layout-cell}}
258 {{/layout-section}}
259 {{/layout}}