Wiki source code of Conference Rooms

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

Search

Navigation

iSymphony