Skip to Content

Wiki source code of Conference Rooms

Version 6.1 by hanlys on 2016/01/03 18:19
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}]/users}}}
115 )))
116 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
117 (((
118 **Description**
119 )))|(((
120 Accesses the state of all conference rooms on a core server.
121 )))
122 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
123 (((
124 **GET**
125 )))|(((
126 Gets all conference rooms on a core server.
127 )))
128
129 = Instance Resource Paths =
130
131 Paths used to access a specific instance of the resource.
132
133 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
134 (((
135 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/conferences}}}
136 )))
137 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
138 (((
139 **Description**
140 )))|(((
141 Provides access to all conference rooms on the specified core server.
142
143 **Parameters:**
144
145 * core_server_id: the id of the parent core server
146 * core_server_slug: the slug of the parent core server
147
148 **Errors:**
149
150 * 404 Not Found: Returned if no core server with the given id or slug exists
151 )))
152 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
153 (((
154 **GET**
155 )))|(((
156 Gets all conference room on the specified core server.
157 )))
158 |(% colspan="2" %)(% colspan="2" %)
159 (((
160
161 )))
162 |=(% colspan="2" %)(% colspan="2" %)
163 (((
164
165 )))
166
167 = Curl Examples =
168
169 === Get all conference rooms ===
170
171 {{code language="bash"}}
172 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/c36544a7-aefc-4e96-92af-2fca93c18c0b/conferences
173 {{/code}}
174
175 === Get a specific conference room ===
176
177 {{code language="bash"}}
178 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
179 {{/code}}
180 {{/layout-cell}}
181 {{/layout-section}}
182 {{/layout}}