Skip to Content

Wiki source code of Conference Rooms

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