Last modified by michaely 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.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The core server voicemail agent REST resource allows access to the list of voicemail agents that are bound to the core server. This resource allows binding and unbinding voicemail agents to and from core servers.
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 "local-vm"
40 {{/code}}
41
42 = (% style="color: rgb(0,0,0);" %)Resource Paths(%%) =
43
44 |=(% colspan="2" %)(% colspan="2" %)
45 (((
46 {{{communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers}}}
47 )))
48 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
49 (((
50 **Description**
51 )))|(((
52 Accesses all the list of voicemail agent identifiers bound to the core server.
53 )))
54 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
55 (((
56 **GET**
57 )))|(((
58 Gets all the list of voicemail agent identifiers bound to the core server.
59 )))
60 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
61 (((
62 **POST
63 **
64 )))|(% colspan="1" %)(% colspan="1" %)
65 (((
66 Adds a specific voicemail agent as a bound agent on the core server.
67 )))
68 |(% colspan="2" %)(% colspan="2" %)
69 (((
70
71 )))
72 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
73 (((
74 {{{communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers/{voicemailAgentIdentifier}}}}
75 )))
76 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
77 (((
78 **Description**
79 )))|(% colspan="1" %)(% colspan="1" %)
80 (((
81 Access a specific bound voicemail agent identifier.
82
83 **Parameters**
84
85 voicemialAgentIdentfier: The identifier of the voicemail agent.**
86 **
87 )))
88 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
89 (((
90 **DELETE**
91 )))|(% colspan="1" %)(% colspan="1" %)
92 (((
93 Removes a specific voicemail agent as a bound agent on the core server.
94 )))
95
96 = Curl Examples =
97
98 === Get all bound voicemail agent identifiers ===
99
100 {{code language="bash"}}
101 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/voicemailAgentIdentifiers
102 {{/code}}
103
104 === Add a bound voicemail agent identifier ===
105
106 {{code language="bash"}}
107 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '"server2-vm"' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/voicemailAgentIdentifiers
108 {{/code}}
109
110 === Remove a bound voicemail agent identifier ===
111
112 {{code language="bash"}}
113 curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/voicemailAgentIdentifiers/server2-vm
114 {{/code}}
115 {{/layout-cell}}
116 {{/layout-section}}
117 {{/layout}}

Search

Navigation

iSymphony