Skip to Content

Wiki source code of Conference Rooms

Version 16.1 by hanlys on 2016/01/03 19:53
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.2+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The live conference room REST resource allows access to the state information of conference rooms on a specified core server.
15 {{/layout-cell}}
16
17 {{layout-cell}}
18 {{panel title="On this page:"}}
19
20
21 {{toc maxLevel="2" indent="1"/}}
22 {{/panel}}
23 {{/layout-cell}}
24 {{/layout-section}}
25
26 {{layout-section ac:type="single"}}
27 {{layout-cell}}
28 = JSON Representation =
29
30 {{code}}
31 {
32 "id":"c97be0d8-3c40-47c5-b8ee-868984b9d7f4",
33 "configurationId":"066a6359-0ff1-49e5-83aa-52083dfbbddb",
34 "displayName":"Main",
35 "identifier":"650",
36 "dialString":"650",
37 "userGenerated":false,
38 "recordings":[],
39 "permissionId":"066a6359-0ff1-49e5-83aa-52083dfbbddb"
40 }
41 {{/code}}
42
43 (% style="line-height: 1.42857;" %)
44 |=(((
45 Property
46 )))|=(((
47 Type
48 )))|=(((
49 Description
50 )))
51 |(((
52 {{{id}}}
53 )))|(((
54 String
55 )))|(((
56 The id of the conference room.
57 )))
58 |(((
59 {{{configurationId}}}
60 )))|(((
61 String
62 )))|(((
63 The id of the configuration object that represents the conference room.
64 )))
65 |(((
66 {{{displayName}}}
67 )))|(((
68 String
69 )))|(((
70 The display name of the conference room.
71 )))
72 |(((
73 {{{identifier}}}
74 )))|(((
75 String
76 )))|(((
77 The identifier of the conference room.
78 )))
79 |(((
80 dialString
81 )))|(((
82 String
83 )))|(((
84 The string used to dial a conference room.
85 )))
86 |(((
87 {{{userGenerated}}}
88 )))|(((
89 Boolean
90 )))|(((
91 True if the conference room is user generated, else false.
92 )))
93 |(((
94 recordings
95 )))|(((
96 Array
97 )))|(((
98 An array of call recordings.
99 )))
100 |(((
101 permissionId
102 )))|(((
103 String
104 )))|(((
105 The conference rooms permission id.
106 )))
107
108 = Root Resource Paths =
109
110 Paths used to access sets of the resource, in relation to parent resources.
111
112 |=(% colspan="2" %)(% colspan="2" %)
113 (((
114 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/conferences}}}
115 )))
116 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
117 (((
118 **Description**
119 )))|(((
120 Provides access to all conference rooms on the specified core server.
121
122 **Parameters:**
123
124 * core_server_id: the id of the parent core server
125 * core_server_slug: the slug of the parent core server
126
127 **Errors:**
128
129 * 404 Not Found: Returned if no core server with the given id or slug exists
130 )))
131 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
132 (((
133 **GET**
134 )))|(((
135 Gets all conference rooms on a core server.
136 )))
137
138 = Instance Resource Paths =
139
140 Paths used to access a specific instance of the resource.
141
142 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
143 (((
144 {{{{root_resource_path}/{conference_room_id}}}}
145 )))
146 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
147 (((
148 **Description**
149 )))|(((
150 Provides access to a specific conference room, by a conference room id.
151
152 **Parameters:**
153
154 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
155 * conference_room_id: the id of the conference room to access
156
157 **Errors:**
158
159 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
160 * 404 Not Found: Returned if no conference room with the given id exists
161 )))
162 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
163 (((
164 **GET**
165 )))|(((
166 Gets the specified conference room.
167 )))
168 |=(% colspan="2" %)(% colspan="2" %)
169 (((
170 {{{{root_resource_path}/getByName/{conference_room_identifier}}}}
171 )))
172 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
173 (((
174 **Description**
175 )))|(% colspan="1" %)(% colspan="1" %)
176 (((
177 Provides access to a specific conference room, by a conference room identifier.
178
179 **Parameters:**
180
181 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
182 * conference_room_identifier: the identifier of the conference room to access
183
184 **Errors:**
185
186 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
187 * 404 Not Found: Returned if no conference room with the given conference room identifier exists
188 )))
189 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
190 (((
191 **GET**
192 )))|(% colspan="1" %)(% colspan="1" %)
193 (((
194 Gets the specified conference room.
195 )))
196
197 = Sub Resource Paths =
198
199 Paths used to access the child resources of this resource.
200
201 |=(% colspan="3" %)(% colspan="3" %)
202 (((
203 {instance_resource_path}/callSegments
204 )))
205 |=(((
206 **Description**
207 )))|(% colspan="2" %)(% colspan="2" %)
208 (((
209 Provides access to all call segments in the specified conference room. See [[Call Segments>>url:http://docs.getisymphony.com/display/ISYMDEV/Call+Segments||shape="rect"]].
210
211 {{info}}
212 Excludes any call segments that are not related to an extension that is bound to a licensed/full user, or have not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
213 {{/info}}
214
215 (% style="line-height: 1.42857;" %)**Parameters:**
216
217 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above.
218
219 **Errors:**
220
221 * 404 Not Found(% style="line-height: 1.42857;" %): Returned if any of the ancestors in the instance resource path could not be found
222 )))
223 |=(((
224 **GET**
225 )))|(% colspan="2" %)(% colspan="2" %)
226 (((
227 Gets all call segments in the specified conference room.
228 )))
229
230 (% style="color: rgb(0,0,0);" %)
231
232
233 = (% style="color: rgb(0,0,0);" %)Curl Examples(%%) =
234
235 === Get all conference rooms ===
236
237 {{code language="bash"}}
238 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/c36544a7-aefc-4e96-92af-2fca93c18c0b/conferences
239 {{/code}}
240
241 === Get a specific conference room ===
242
243 {{code language="bash"}}
244 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/c36544a7-aefc-4e96-92af-2fca93c18c0b/conferences/c97be0d8-3c40-47c5-b8ee-868984b9d7f4
245 {{/code}}
246 {{/layout-cell}}
247 {{/layout-section}}
248 {{/layout}}