Wiki source code of Extensions
Version 26.1 by michaely on 2015/07/09 18:52
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{layout}} | ||
2 | {{layout-section ac:type="two_right_sidebar"}} | ||
3 | {{layout-cell}} | ||
4 | (% style="color: rgb(0,0,0);font-size: 24.0px;line-height: 1.25;" %)Description | ||
5 | |||
6 | The live extension REST resource allows access to information about the status of a specific extension in the system. This resource also provides actions for originating calls, and enabling/disabling Do Not Disturb on an extension. | ||
7 | |||
8 | {{info}} | ||
9 | This resource is restricted by licensing. See the resource and action path information below for more details. | ||
10 | {{/info}} | ||
11 | |||
12 | \\ | ||
13 | {{/layout-cell}} | ||
14 | |||
15 | {{layout-cell}} | ||
16 | {{panel title="On this page:"}} | ||
17 | |||
18 | |||
19 | {{toc maxLevel="2" indent="1"/}} | ||
20 | {{/panel}} | ||
21 | {{/layout-cell}} | ||
22 | {{/layout-section}} | ||
23 | |||
24 | {{layout-section ac:type="single"}} | ||
25 | {{layout-cell}} | ||
26 | (% style="color: rgb(0,0,0);" %) | ||
27 | |||
28 | |||
29 | = (% style="color: rgb(0,0,0);" %)Root Resource Paths(%%) = | ||
30 | |||
31 | |=(% colspan="2" %)(% colspan="2" %) | ||
32 | ((( | ||
33 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions}}} | ||
34 | ))) | ||
35 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
36 | ((( | ||
37 | **Description** | ||
38 | )))|((( | ||
39 | Provides access to all extensions in a specified core server. | ||
40 | |||
41 | {{info}} | ||
42 | Excludes any extensions that are not bound to a licensed/full user. | ||
43 | {{/info}} | ||
44 | |||
45 | **Parameters:** | ||
46 | |||
47 | * core_server_id: the id of the parent core server\\ | ||
48 | * core_server_slug: the slug of the parent core server | ||
49 | |||
50 | **Errors:** | ||
51 | |||
52 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
53 | ))) | ||
54 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
55 | ((( | ||
56 | **GET** | ||
57 | )))|(% colspan="1" %)(% colspan="1" %) | ||
58 | ((( | ||
59 | Gets all extensions in the specified core server. | ||
60 | ))) | ||
61 | |(% colspan="1" %)(% colspan="1" %) | ||
62 | ((( | ||
63 | |||
64 | )))|(% colspan="1" %)(% colspan="1" %) | ||
65 | ((( | ||
66 | |||
67 | ))) | ||
68 | |=(% colspan="2" %)(% colspan="2" %) | ||
69 | ((( | ||
70 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/user/[{user_id} | getByName/{username}]/extensions}}} | ||
71 | ))) | ||
72 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
73 | ((( | ||
74 | **Description** | ||
75 | )))|(% colspan="1" %)(% colspan="1" %) | ||
76 | ((( | ||
77 | Provides access to all the extensions bound to the specified user. | ||
78 | |||
79 | {{info}} | ||
80 | Excludes any extensions that are not bound to a licensed/full user. | ||
81 | {{/info}} | ||
82 | |||
83 | **Parameters:** | ||
84 | |||
85 | * core_server_id: the id of the parent core server\\ | ||
86 | * core_server_slug: the slug of the parent core server | ||
87 | * user_id: the id of the parent user | ||
88 | * username: the username of the parent user | ||
89 | |||
90 | **Errors:** | ||
91 | |||
92 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
93 | * 404 Not Found: Returned if no user with the given id or username exists | ||
94 | ))) | ||
95 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
96 | ((( | ||
97 | **GET** | ||
98 | )))|(% colspan="1" %)(% colspan="1" %) | ||
99 | ((( | ||
100 | Gets all extensions bound to the specified extension | ||
101 | ))) | ||
102 | |||
103 | |||
104 | |||
105 | (% style="color: rgb(0,0,0);" %) | ||
106 | |||
107 | |||
108 | {{code}} | ||
109 | communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions | ||
110 | {{/code}} | ||
111 | |||
112 | = JSON Representation = | ||
113 | |||
114 | {{code}} | ||
115 | { | ||
116 | "id": "e640205f-bc76-4db4-8e03-bf34eb33a8ce", | ||
117 | "extensionNumber": "4224", | ||
118 | "displayName": "Michael Y", | ||
119 | "configurationId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f", | ||
120 | "permissionId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f" | ||
121 | } | ||
122 | {{/code}} | ||
123 | |||
124 | |=((( | ||
125 | Property | ||
126 | )))|=((( | ||
127 | Type | ||
128 | )))|=((( | ||
129 | Description | ||
130 | ))) | ||
131 | |((( | ||
132 | {{{id}}} | ||
133 | )))|((( | ||
134 | String | ||
135 | )))|((( | ||
136 | The id of the extension. | ||
137 | ))) | ||
138 | |(% colspan="1" %)(% colspan="1" %) | ||
139 | ((( | ||
140 | extensionNumber | ||
141 | )))|(% colspan="1" %)(% colspan="1" %) | ||
142 | ((( | ||
143 | String | ||
144 | )))|(% colspan="1" %)(% colspan="1" %) | ||
145 | ((( | ||
146 | The number used to access the extension. | ||
147 | ))) | ||
148 | |(% colspan="1" %)(% colspan="1" %) | ||
149 | ((( | ||
150 | displayName | ||
151 | )))|(% colspan="1" %)(% colspan="1" %) | ||
152 | ((( | ||
153 | String | ||
154 | )))|(% colspan="1" %)(% colspan="1" %) | ||
155 | ((( | ||
156 | The display name of the extension. | ||
157 | ))) | ||
158 | |(% colspan="1" %)(% colspan="1" %) | ||
159 | ((( | ||
160 | {{{configurationId}}} | ||
161 | )))|(% colspan="1" %)(% colspan="1" %) | ||
162 | ((( | ||
163 | String | ||
164 | )))|(% colspan="1" %)(% colspan="1" %) | ||
165 | ((( | ||
166 | The id of the configuration object that represents the extension. | ||
167 | ))) | ||
168 | |(% colspan="1" %)(% colspan="1" %) | ||
169 | ((( | ||
170 | {{{permissionId}}} | ||
171 | )))|(% colspan="1" %)(% colspan="1" %) | ||
172 | ((( | ||
173 | String | ||
174 | )))|(% colspan="1" %)(% colspan="1" %) | ||
175 | ((( | ||
176 | The extension's permission id. | ||
177 | ))) | ||
178 | |||
179 | = Resource Paths = | ||
180 | |||
181 | The extension resource can be accessed from several different parent resources. The following resource paths have been organized by the parent path used to access the resource. | ||
182 | |||
183 | == (% style="color: rgb(0,0,0);" %)Core Server Parent(%%) == | ||
184 | |||
185 | |=(% colspan="2" %)(% colspan="2" %) | ||
186 | ((( | ||
187 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions}}} | ||
188 | ))) | ||
189 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
190 | ((( | ||
191 | **Description** | ||
192 | )))|((( | ||
193 | Accesses the state of all extensions, in a core server. | ||
194 | |||
195 | {{info}} | ||
196 | The returned result will exclude any extensions that are not bound to a licensed/full user. | ||
197 | {{/info}} | ||
198 | |||
199 | (% style="line-height: 1.4285715;" %)**Parameters:** | ||
200 | |||
201 | * core_server_id: the id of the parent core server\\ | ||
202 | * core_server_slug: the slug of the parent core server | ||
203 | |||
204 | **Errors:** | ||
205 | |||
206 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
207 | ))) | ||
208 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
209 | ((( | ||
210 | **GET** | ||
211 | )))|((( | ||
212 | Gets the state of all extensions, in a specified core server. | ||
213 | ))) | ||
214 | |(% colspan="2" %)(% colspan="2" %) | ||
215 | ((( | ||
216 | |||
217 | ))) | ||
218 | |=(% colspan="2" %)(% colspan="2" %) | ||
219 | ((( | ||
220 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions/{extension_id}}}} | ||
221 | ))) | ||
222 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
223 | ((( | ||
224 | **Description** | ||
225 | )))|(% colspan="1" %)(% colspan="1" %) | ||
226 | ((( | ||
227 | Accesses the state of a specific extension, in a core server, by extension id. | ||
228 | |||
229 | {{info}} | ||
230 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
231 | {{/info}} | ||
232 | |||
233 | **Parameters:** | ||
234 | |||
235 | * core_server_id: the id of the parent core server\\ | ||
236 | * core_server_slug: the slug of the parent core server | ||
237 | * extension_id: the id of the extension to access | ||
238 | |||
239 | **Errors:** | ||
240 | |||
241 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
242 | * 404 Not Found: Returned if no extension exists with the give id, in the specified core server | ||
243 | * 403 Forbidden: Returned if the extension is not bound to a licensed/full user | ||
244 | ))) | ||
245 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
246 | ((( | ||
247 | **GET** | ||
248 | )))|(% colspan="1" %)(% colspan="1" %) | ||
249 | ((( | ||
250 | Gets the state of a specific extension, in a core server. | ||
251 | ))) | ||
252 | |(% colspan="2" %)(% colspan="2" %) | ||
253 | ((( | ||
254 | |||
255 | ))) | ||
256 | |=(% colspan="2" %)(% colspan="2" %) | ||
257 | ((( | ||
258 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions/getByName/{extension_number}}}} | ||
259 | ))) | ||
260 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
261 | ((( | ||
262 | **Description** | ||
263 | )))|(% colspan="1" %)(% colspan="1" %) | ||
264 | ((( | ||
265 | Accesses the state of a specific extension, in a core server, by extension number. | ||
266 | |||
267 | {{info}} | ||
268 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
269 | {{/info}} | ||
270 | |||
271 | **Parameters:** | ||
272 | |||
273 | * core_server_id: the id of the parent core server\\ | ||
274 | * core_server_slug: the slug of the parent core server | ||
275 | * extension_number: the extension number of the extension to access | ||
276 | |||
277 | **Errors:** | ||
278 | |||
279 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
280 | * 404 Not Found: Returned if no extension exists with the give extension number, in the specified core server | ||
281 | * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user | ||
282 | ))) | ||
283 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
284 | ((( | ||
285 | **GET** | ||
286 | )))|(% colspan="1" %)(% colspan="1" %) | ||
287 | ((( | ||
288 | Gets the state of a specific extension, in a core server. | ||
289 | ))) | ||
290 | |(% colspan="2" %)(% colspan="2" %) | ||
291 | ((( | ||
292 | |||
293 | ))) | ||
294 | |=(% colspan="2" %)(% colspan="2" %) | ||
295 | ((( | ||
296 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions/[{extension_id} getByName/{extension_number}]/agents}}} | ||
297 | ))) | ||
298 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
299 | ((( | ||
300 | **Description** | ||
301 | )))|(% colspan="1" %)(% colspan="1" %) | ||
302 | ((( | ||
303 | Access the sub/child resource for the queue agents bound to the specified extension. | ||
304 | |||
305 | {{info}} | ||
306 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
307 | {{/info}} | ||
308 | |||
309 | **Parameters:** | ||
310 | |||
311 | * core_server_id: the id of the parent core server\\ | ||
312 | * core_server_slug: the slug of the parent core server | ||
313 | * extension_id: the id of the extension to access | ||
314 | * extension_number: the extension number of the parent extension | ||
315 | |||
316 | **Errors:** | ||
317 | |||
318 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
319 | * 404 Not Found: Returned if no extension exists with the give id or extension number, in the specified core server. | ||
320 | * 403 Forbidden: if the extension is not bound to a licensed/full user | ||
321 | ))) | ||
322 | |(% colspan="2" %)(% colspan="2" %) | ||
323 | ((( | ||
324 | |||
325 | ))) | ||
326 | |=(% colspan="2" %)(% colspan="2" %) | ||
327 | ((( | ||
328 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions/[{extension_id} getByName/{extension_number}]/callSegments}}} | ||
329 | ))) | ||
330 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
331 | ((( | ||
332 | **Description** | ||
333 | )))|(% colspan="1" %)(% colspan="1" %) | ||
334 | ((( | ||
335 | Access the sub/child resource for the call segments bound to the specified extension. | ||
336 | |||
337 | {{info}} | ||
338 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
339 | {{/info}} | ||
340 | |||
341 | **Parameters:** | ||
342 | |||
343 | * core_server_id: the id of the parent core server\\ | ||
344 | * core_server_slug: the slug of the parent core server | ||
345 | * extension_id: the id of the extension to access | ||
346 | * extension_number: the extension number of the parent extension | ||
347 | |||
348 | **Errors:** | ||
349 | |||
350 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
351 | * 404 Not Found: Returned if no extension exists with the given id or extension number, in the specified core server. | ||
352 | * 403 Forbidden: if the extension is not bound to a licensed/full user | ||
353 | ))) | ||
354 | |||
355 | == User Parent == | ||
356 | |||
357 | |=(% colspan="2" %)(% colspan="2" %) | ||
358 | ((( | ||
359 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/extensions}}} | ||
360 | ))) | ||
361 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
362 | ((( | ||
363 | **Description** | ||
364 | )))|((( | ||
365 | Accesses the state of all extensions bound to a specific user, in a core server. | ||
366 | |||
367 | {{info}} | ||
368 | The returned result will exclude any extensions that are not bound to a licensed/full user. | ||
369 | {{/info}} | ||
370 | |||
371 | **Parameters:** | ||
372 | |||
373 | * core_server_id: the id of the parent core server\\ | ||
374 | * core_server_slug: the slug of the parent core server | ||
375 | * user_id: the id of the parent user | ||
376 | * username: the username of the parent user | ||
377 | |||
378 | **Errors:** | ||
379 | |||
380 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
381 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
382 | * 403 Forbidden: if the extension is not bound to a licensed/full user | ||
383 | ))) | ||
384 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
385 | ((( | ||
386 | **GET** | ||
387 | )))|((( | ||
388 | Gets the state of all extensions bound to a specific user. | ||
389 | ))) | ||
390 | |(% colspan="2" %)(% colspan="2" %) | ||
391 | ((( | ||
392 | |||
393 | ))) | ||
394 | |=(% colspan="2" %)(% colspan="2" %) | ||
395 | ((( | ||
396 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/extensions/{extension_id}}}} | ||
397 | ))) | ||
398 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
399 | ((( | ||
400 | **Description** | ||
401 | )))|(% colspan="1" %)(% colspan="1" %) | ||
402 | ((( | ||
403 | Accesses the state of a specific extension, bound to a user, by extension id. | ||
404 | |||
405 | {{info}} | ||
406 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
407 | {{/info}} | ||
408 | |||
409 | **Parameters:** | ||
410 | |||
411 | * core_server_id: the id of the parent core server\\ | ||
412 | * core_server_slug: the slug of the parent core server | ||
413 | * user_id: the id of the parent user | ||
414 | * username: the username of the parent user | ||
415 | * extension_id: the id of the extension to access | ||
416 | |||
417 | **Errors:** | ||
418 | |||
419 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
420 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
421 | * 404 Not Found: Returned if no extension exists with the given id, that is bound to the specified user. | ||
422 | * 403 Forbidden: Returned if the extension is not bound to a licensed/full user | ||
423 | ))) | ||
424 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
425 | ((( | ||
426 | **GET** | ||
427 | )))|(% colspan="1" %)(% colspan="1" %) | ||
428 | ((( | ||
429 | Gets the state of a specific extension bound to a user. | ||
430 | ))) | ||
431 | |(% colspan="2" %)(% colspan="2" %) | ||
432 | ((( | ||
433 | |||
434 | ))) | ||
435 | |=(% colspan="2" %)(% colspan="2" %) | ||
436 | ((( | ||
437 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/extensions/getByName/{extension_number}}}} | ||
438 | ))) | ||
439 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
440 | ((( | ||
441 | **Description** | ||
442 | )))|(% colspan="1" %)(% colspan="1" %) | ||
443 | ((( | ||
444 | Accesses the state of a specific extension, bound to a user, by extension number. | ||
445 | |||
446 | {{info}} | ||
447 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
448 | {{/info}} | ||
449 | |||
450 | **Parameters:** | ||
451 | |||
452 | * core_server_id: the id of the parent core server\\ | ||
453 | * core_server_slug: the slug of the parent core server | ||
454 | * user_id: the id of the parent user | ||
455 | * username: the username of the parent user | ||
456 | * extension_id: the id of the parent extension | ||
457 | * extension_number: the extension number of the parent extension | ||
458 | |||
459 | **Errors:** | ||
460 | |||
461 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
462 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
463 | * 404 Not Found: Returned if no extension exists with the given id, that is bound to the specified user. | ||
464 | * 403 Forbidden: Returned if the extension is not bound to a licensed/full user | ||
465 | ))) | ||
466 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
467 | ((( | ||
468 | **GET** | ||
469 | )))|(% colspan="1" %)(% colspan="1" %) | ||
470 | ((( | ||
471 | Gets the state of a specific extension bound to a user. | ||
472 | ))) | ||
473 | |(% colspan="2" %)(% colspan="2" %) | ||
474 | ((( | ||
475 | |||
476 | ))) | ||
477 | |=(% colspan="2" %)(% colspan="2" %) | ||
478 | ((( | ||
479 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/extensions/[{extension_id} getByName/{extension_number}]/agents}}} | ||
480 | ))) | ||
481 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
482 | ((( | ||
483 | **Description** | ||
484 | )))|(% colspan="1" %)(% colspan="1" %) | ||
485 | ((( | ||
486 | Access the sub/child resource for the queue agents bound to the specified extension, that is bound to the specified user. | ||
487 | |||
488 | {{info}} | ||
489 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
490 | {{/info}} | ||
491 | |||
492 | **Parameters:** | ||
493 | |||
494 | * core_server_id: the id of the parent core server\\ | ||
495 | * core_server_slug: the slug of the parent core server | ||
496 | * user_id: the id of the parent user | ||
497 | * username: the username of the parent user | ||
498 | * extension_id: the id of the parent extension | ||
499 | * extension_number: the extension number of the parent extension | ||
500 | |||
501 | **Errors:** | ||
502 | |||
503 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
504 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
505 | * 404 Not Found: Returned if no extension exists with the given id or extension number, that is bound to the specified user. | ||
506 | * 403 Forbidden: Returned if the extension is not bound to a licensed/full user | ||
507 | ))) | ||
508 | |(% colspan="2" %)(% colspan="2" %) | ||
509 | ((( | ||
510 | |||
511 | ))) | ||
512 | |=(% colspan="2" %)(% colspan="2" %) | ||
513 | ((( | ||
514 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/extensions/[{extension_id} getByName/{extension_number}]/callSegments}}} | ||
515 | ))) | ||
516 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
517 | ((( | ||
518 | **Description** | ||
519 | )))|(% colspan="1" %)(% colspan="1" %) | ||
520 | ((( | ||
521 | Access the sub/child resource for the call segments bound to the specified extension, that is bound to the specified user. | ||
522 | |||
523 | {{info}} | ||
524 | This resource will not be available if the extension is not bound to a licensed/full user. | ||
525 | {{/info}} | ||
526 | |||
527 | **Parameters:** | ||
528 | |||
529 | * core_server_id: the id of the parent core server\\ | ||
530 | * core_server_slug: the slug of the parent core server | ||
531 | * user_id: the id of the parent user | ||
532 | * username: the username of the parent user | ||
533 | * extension_id: the id of the parent extension | ||
534 | * extension_number: the extension number of the parent extension | ||
535 | |||
536 | **Errors:** | ||
537 | |||
538 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
539 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
540 | * 404 Not Found: Returned if no extension exists with the given id or extension number, that is bound to the specified user. | ||
541 | * 403 Forbidden: Returned if the extension is not bound to a licensed/full user | ||
542 | ))) | ||
543 | |||
544 | = Action Paths = | ||
545 | |||
546 | |=(% colspan="2" %)(% colspan="2" %) | ||
547 | ((( | ||
548 | {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/status/set}}} | ||
549 | ))) | ||
550 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
551 | ((( | ||
552 | **Description** | ||
553 | )))|((( | ||
554 | Updates the status of a user. | ||
555 | |||
556 | {{info}} | ||
557 | This action will not be available if the user is not licensed/full, or no license is installed on the core server. | ||
558 | {{/info}} | ||
559 | |||
560 | (% style="line-height: 1.4285715;" %)**Parameters:** | ||
561 | |||
562 | * core_server_id: the id of the parent core server\\ | ||
563 | * core_server_slug: the slug of the parent core server | ||
564 | * user_id: the id of the user to update status on | ||
565 | * user_name: the username of the user to update status on | ||
566 | |||
567 | **Errors:** | ||
568 | |||
569 | * 404 Not Found: Returned if no core server with the given id or slug exists | ||
570 | * 404 Not Found: Returned if no user with the given id or username exists in the specified core server | ||
571 | * 422 Unprocessable Entity: Returned if no JSON name property is given | ||
572 | * 422 Unprocessable Entity: Returned if no JSON type property is given | ||
573 | * 422 Unprocessable Entity: Returned if the JSON type property value is not valid | ||
574 | * 422 Unprocessable Entity: Returned if the JSON returnTime property value is to0 large, or is a non numerical value. | ||
575 | * 403 Forbidden: Returned if the user is not licensed/full, or no license is installed on the core server. | ||
576 | ))) | ||
577 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
578 | ((( | ||
579 | **JSON** | ||
580 | )))|(% colspan="1" %)(% colspan="1" %) | ||
581 | ((( | ||
582 | {{code}} | ||
583 | { | ||
584 | "name": "Went back in time", | ||
585 | "type": "away", | ||
586 | "note": "Tell Doc Brown", | ||
587 | "returnTime": 499132800 | ||
588 | } | ||
589 | {{/code}} | ||
590 | |||
591 | **Properties:** | ||
592 | |||
593 | |=((( | ||
594 | Property | ||
595 | )))|=((( | ||
596 | Type | ||
597 | )))|=((( | ||
598 | Description | ||
599 | ))) | ||
600 | |(% colspan="1" %)(% colspan="1" %) | ||
601 | ((( | ||
602 | {{{name}}} | ||
603 | )))|(% colspan="1" %)(% colspan="1" %) | ||
604 | ((( | ||
605 | String | ||
606 | )))|(% colspan="1" %)(% colspan="1" %) | ||
607 | ((( | ||
608 | The status name. | ||
609 | ))) | ||
610 | |(% colspan="1" %)(% colspan="1" %) | ||
611 | ((( | ||
612 | type | ||
613 | )))|(% colspan="1" %)(% colspan="1" %) | ||
614 | ((( | ||
615 | String | ||
616 | )))|(% colspan="1" %)(% colspan="1" %) | ||
617 | ((( | ||
618 | The status type. Determines the icon used for the status. See Status Types above. | ||
619 | ))) | ||
620 | |(% colspan="1" %)(% colspan="1" %) | ||
621 | ((( | ||
622 | note | ||
623 | )))|(% colspan="1" %)(% colspan="1" %) | ||
624 | ((( | ||
625 | String | ||
626 | )))|(% colspan="1" %)(% colspan="1" %) | ||
627 | ((( | ||
628 | The note for the status. | ||
629 | ))) | ||
630 | |(% colspan="1" %)(% colspan="1" %) | ||
631 | ((( | ||
632 | returnTime | ||
633 | )))|(% colspan="1" %)(% colspan="1" %) | ||
634 | ((( | ||
635 | Long | ||
636 | )))|(% colspan="1" %)(% colspan="1" %) | ||
637 | ((( | ||
638 | The time the user is returning, or -1 for no return time. Represented as a unix timestamp, in milliseconds. | ||
639 | ))) | ||
640 | |||
641 | ** | ||
642 | ** | ||
643 | ))) | ||
644 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
645 | ((( | ||
646 | **POST** | ||
647 | )))|(% colspan="1" %)(% colspan="1" %) | ||
648 | ((( | ||
649 | Updates the status of the user. | ||
650 | ))) | ||
651 | |||
652 | = | ||
653 | Curl Examples = | ||
654 | |||
655 | === Get the status of a user in a specific core server === | ||
656 | |||
657 | {{code language="bash"}} | ||
658 | curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/status | ||
659 | {{/code}} | ||
660 | |||
661 | === Set the status of a user in a specific core server === | ||
662 | |||
663 | {{code language="bash"}} | ||
664 | curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"name" : "Went back in time", "type" : "away", "note" : "Tell Doc Brown", "returnTime" : 499132800}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/status/set | ||
665 | {{/code}} | ||
666 | {{/layout-cell}} | ||
667 | {{/layout-section}} | ||
668 | {{/layout}} |