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 user status color REST resource allows access to the colors a user has configured for representation of call status in the client. This resource allows changing of the status colors for the specific user.
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 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
29
30 {{code}}
31 communication_manager/rest/config/core/{coreServerId}/users/{userId}/userStatusColors
32 {{/code}}
33
34 = JSON Representation =
35
36 {{code}}
37 {
38 "id": "d92027c5-9b55-4d7f-aa85-0321f09183c4",
39 "identifier": "ringing",
40 "color": "FFFF80"
41 }
42 {{/code}}
43
44 |=(((
45 Property
46 )))|=(((
47 Type
48 )))|=(((
49 Description
50 )))
51 |(((
52 {{{id}}}
53 )))|(((
54 String
55 )))|(((
56 Configuration id of the status color.
57 )))
58 |(% colspan="1" %)(% colspan="1" %)
59 (((
60 identifier
61 )))|(% colspan="1" %)(% colspan="1" %)
62 (((
63 String
64 )))|(% colspan="1" %)(% colspan="1" %)
65 (((
66 The identifier of the status the color is for. The following identifiers are allowed:
67
68 |=(((
69 Identifier
70 )))|=(((
71 Description
72 )))
73 |(((
74 {{{ringing}}}
75 )))|(((
76 Color used when the user's phone is being rung.
77 )))
78 |(% colspan="1" %)(% colspan="1" %)
79 (((
80 {{{externalCall}}}
81 )))|(% colspan="1" %)(% colspan="1" %)
82 (((
83 Color used when the user's phone is on an external call.
84 )))
85 |(% colspan="1" %)(% colspan="1" %)
86 (((
87 {{{queueCall}}}
88 )))|(% colspan="1" %)(% colspan="1" %)
89 (((
90 Color used when the user's phone is on a queue call.
91 )))
92 |(% colspan="1" %)(% colspan="1" %)
93 (((
94 {{{logged_in}}}
95 )))|(% colspan="1" %)(% colspan="1" %)
96 (((
97 Color used when the user is logged into the panel.
98 )))
99 |(% colspan="1" %)(% colspan="1" %)
100 (((
101 {{{dialing}}}
102 )))|(% colspan="1" %)(% colspan="1" %)
103 (((
104 Color used when the user's phone is dialing out.
105 )))
106 |(% colspan="1" %)(% colspan="1" %)
107 (((
108 {{{unregistered}}}
109 )))|(% colspan="1" %)(% colspan="1" %)
110 (((
111 Color used when the user's phone is unregistered.
112 )))
113 |(% colspan="1" %)(% colspan="1" %)
114 (((
115 {{{logged_out}}}
116 )))|(% colspan="1" %)(% colspan="1" %)
117 (((
118 Color used when the user is logged out of the panel.
119 )))
120 |(% colspan="1" %)(% colspan="1" %)
121 (((
122 {{{none}}}
123 )))|(% colspan="1" %)(% colspan="1" %)
124 (((
125 Color used when the user's phone is registered but idle.
126 )))
127 |(((
128 {{{internalCall}}}
129 )))|(((
130 Color used when the user's phone is on an internal call.
131 )))
132 |(% colspan="1" %)(% colspan="1" %)
133 (((
134 {{{hold}}}
135 )))|(% colspan="1" %)(% colspan="1" %)
136 (((
137 Color used when the user has a call on hold.
138 )))
139 )))
140 |(% colspan="1" %)(% colspan="1" %)
141 (((
142 color
143 )))|(% colspan="1" %)(% colspan="1" %)
144 (((
145 String
146 )))|(% colspan="1" %)(% colspan="1" %)
147 (((
148 The color of the status. Represented as an RGB Hex value (e.g. FFFFFF)
149 )))
150
151 = Resource Paths =
152
153 |=(% colspan="2" %)(% colspan="2" %)
154 (((
155 {{{communication_manager/rest/config/core/{coreServerId}/users/{userId}/userStatusColors}}}
156 )))
157 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
158 (((
159 **Description**
160 )))|(((
161 Accesses all the user's status colors.
162 )))
163 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
164 (((
165 **GET**
166 )))|(((
167 Gets all the user's status colors.
168 )))
169 |(% colspan="2" %)(% colspan="2" %)
170 (((
171
172 )))
173 |=(% colspan="2" %)(% colspan="2" %)
174 (((
175 {{{communication_manager/rest/config/core/{coreServerId}/users/{userId}/userStatusColors/{userStatusColorId}}}}
176 )))
177 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
178 (((
179 **Description**
180 )))|(((
181 Accesses the configuration of a specific user status color.
182
183 **Parameters:**
184
185 * userStatusColorId: The configuration id of the user status color.
186 )))
187 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
188 (((
189 **GET**
190 )))|(((
191 Gets the configuration of the specified user status color.
192
193 **Errors:**
194
195 * 404 'A user status color with the given id does not exist': Returned if no user status color exists with the given id.
196 )))
197 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
198 (((
199 **PUT**
200 )))|(% colspan="1" %)(% colspan="1" %)
201 (((
202 Updates the specified user status color.
203
204 **Errors:**
205
206 * 404 'A user status color with the given id does not exist': Returned if no user status color exists with the given id.
207 * 400 'The specified color value must be a valid RGB value in the form ~#~#~#~#~#~#': Returned if the color value is not a valid RGB color value.
208 )))
209
210 = Curl Examples =
211
212 === Get all user status colors for a user ===
213
214 {{code language="bash"}}
215 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf/userStatusColors
216 {{/code}}
217
218 === Get the configuration for a specific user status color ===
219
220 {{code language="bash"}}
221 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf/userStatusColors/8a2d9486-b5f4-4601-8680-4b6825566e20
222 {{/code}}
223
224 === Update a user status color ===
225
226 {{code language="bash"}}
227 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"d92027c5-9b55-4d7f-aa85-0321f09183c4","identifier":"ringing","color":"F3F480"}' http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf/userStatusColors/8a2d9486-b5f4-4601-8680-4b6825566e20
228 {{/code}}
229 {{/layout-cell}}
230 {{/layout-section}}
231 {{/layout}}

Search

Navigation

iSymphony