Submit an Interaction
Declare an Audio Interaction
Metadata
The use of the metadata parameter when declaring an interaction allows for the importation of additional information about the interaction which will be useful when performing analysis and reporting with ElevateAI Explore.
If the metadata body parameter is specified in a Declare for an account that is not enabled for Explore, the operation will return a response of 400 Bad Request.
ElevateAI has both standard metadata fields and custom fields. The standard fields are those most commonly found in contact center call recording environments and provide key information for identifying the details of an interaction.
Though the values of all fields will be strings when passed into the Declare operation, the values for certain fields must fit the expected type of that field.
DateTime fields must be in the ISO 8601 (UTC) format shown in the JSON example below, with the T time introduction.
The custom fields all fall within the "custom" section. The values within these entries will all be required to match the associated type: dateTime, text, integer and decimal.
The number of available fields for the custom field types is as follows:
Field Type | Count |
|---|---|
dateTime | 45 |
text | 165 |
integer | 50 |
decimal | 40 |
Custom field names are in the format custom.{types}.{type}#. For example the 8th integer field is 'custom.integers.integer8'.
Any fields which do not map to an ElevateAI field are ignored without feedback.
Following are a metadata sample in JSON format and a class specification for the complete metadata schema.
JSON
C#
1namespace ElevateAI
2{
3 internal class EaiMetadata
4 {
5 public string? Category { get; set; }
6 public string? Direction { get; set; }
7 public string? Recorded { get; set; }
8 public EaiMetaAudio? Audio { get; set; }
9 public EaiMetaAgent? Agent { get; set; }
10 public EaiMetaSite? Site { get; set; }
11 public EaiMetaCustomer? Customer { get; set; }
12 public EaiMetaCustom? Custom { get; set; }
13 }
14
15 public class EaiMetaAudio
16 {
17 public string? Extension { get; set; }
18 public string? DNIS { get; set; }
19 }
20
21 public class EaiMetaAgent
22 {
23 public string? Id { get; set; }
24 public string? Name { get; set; }
25 public EaiMetaSupervisor? Supervisor { get; set; }
26 public EaiMetaGroup? Group { get; set; }
27 }
28
29 public class EaiMetaSupervisor
30 {
31 public string? Id { get; set; }
32 public string? Name { get; set; }
33 }
34
35 public class EaiMetaGroup
36 {
37 public string? Id { get; set; }
38 public string? Name { get; set; }
39 }
40
41 public class EaiMetaSite
42 {
43 public string? Id { get; set; }
44 public string? Name { get; set; }
45 }
46
47 public class EaiMetaCustomer
48 {
49 public string? Id { get; set; }
50 public string? Name { get; set; }
51 public string? City { get; set; }
52 public string? State { get; set; }
53 }
54
55 public class EaiMetaCustom
56 {
57 public EaiDateTime? DateTimes { get; set; }
58 public EaiText? Texts { get; set; }
59 public EaiInteger? Integers { get; set; }
60 public EaiDecimal? Decimals { get; set; }
61 }
62
63 public class EaiDateTime
64 {
65 public DateTime? DateTime1 { get; set; }
66 public DateTime? DateTime2 { get; set; }
67 public DateTime? DateTime3 { get; set; }
68 public DateTime? DateTime4 { get; set; }
69 public DateTime? DateTime5 { get; set; }
70 public DateTime? DateTime6 { get; set; }
71 public DateTime? DateTime7 { get; set; }
72 public DateTime? DateTime8 { get; set; }
73 public DateTime? DateTime9 { get; set; }
74 public DateTime? DateTime10 { get; set; }
75 public DateTime? DateTime11 { get; set; }
76 public DateTime? DateTime12 { get; set; }
77 public DateTime? DateTime13 { get; set; }
78 public DateTime? DateTime14 { get; set; }
79 public DateTime? DateTime15 { get; set; }
80 public DateTime? DateTime16 { get; set; }
81 public DateTime? DateTime17 { get; set; }
82 public DateTime? DateTime18 { get; set; }
83 public DateTime? DateTime19 { get; set; }
84 public DateTime? DateTime20 { get; set; }
85 public DateTime? DateTime21 { get; set; }
86 public DateTime? DateTime22 { get; set; }
87 public DateTime? DateTime23 { get; set; }
88 public DateTime? DateTime24 { get; set; }
89 public DateTime? DateTime25 { get; set; }
90 public DateTime? DateTime26 { get; set; }
91 public DateTime? DateTime27 { get; set; }
92 public DateTime? DateTime28 { get; set; }
93 public DateTime? DateTime29 { get; set; }
94 public DateTime? DateTime30 { get; set; }
95 public DateTime? DateTime31 { get; set; }
96 public DateTime? DateTime32 { get; set; }
97 public DateTime? DateTime33 { get; set; }
98 public DateTime? DateTime34 { get; set; }
99 public DateTime? DateTime35 { get; set; }
100 public DateTime? DateTime36 { get; set; }
101 public DateTime? DateTime37 { get; set; }
102 public DateTime? DateTime38 { get; set; }
103 public DateTime? DateTime39 { get; set; }
104 public DateTime? DateTime40 { get; set; }
105 public DateTime? DateTime41 { get; set; }
106 public DateTime? DateTime42 { get; set; }
107 public DateTime? DateTime43 { get; set; }
108 public DateTime? DateTime44 { get; set; }
109 public DateTime? DateTime45 { get; set; }
110 }
111
112 public class EaiText
113 {
114 public string? Text1 { get; set; }
115 public string? Text2 { get; set; }
116 public string? Text3 { get; set; }
117 public string? Text4 { get; set; }
118 public string? Text5 { get; set; }
119 public string? Text6 { get; set; }
120 public string? Text7 { get; set; }
121 public string? Text8 { get; set; }
122 public string? Text9 { get; set; }
123 public string? Text10 { get; set; }
124 public string? Text11 { get; set; }
125 public string? Text12 { get; set; }
126 public string? Text13 { get; set; }
127 public string? Text14 { get; set; }
128 public string? Text15 { get; set; }
129 public string? Text16 { get; set; }
130 public string? Text17 { get; set; }
131 public string? Text18 { get; set; }
132 public string? Text19 { get; set; }
133 public string? Text20 { get; set; }
134 public string? Text21 { get; set; }
135 public string? Text22 { get; set; }
136 public string? Text23 { get; set; }
137 public string? Text24 { get; set; }
138 public string? Text25 { get; set; }
139 public string? Text26 { get; set; }
140 public string? Text27 { get; set; }
141 public string? Text28 { get; set; }
142 public string? Text29 { get; set; }
143 public string? Text30 { get; set; }
144 public string? Text31 { get; set; }
145 public string? Text32 { get; set; }
146 public string? Text33 { get; set; }
147 public string? Text34 { get; set; }
148 public string? Text35 { get; set; }
149 public string? Text36 { get; set; }
150 public string? Text37 { get; set; }
151 public string? Text38 { get; set; }
152 public string? Text39 { get; set; }
153 public string? Text40 { get; set; }
154 public string? Text41 { get; set; }
155 public string? Text42 { get; set; }
156 public string? Text43 { get; set; }
157 public string? Text44 { get; set; }
158 public string? Text45 { get; set; }
159 public string? Text46 { get; set; }
160 public string? Text47 { get; set; }
161 public string? Text48 { get; set; }
162 public string? Text49 { get; set; }
163 public string? Text50 { get; set; }
164 public string? Text51 { get; set; }
165 public string? Text52 { get; set; }
166 public string? Text53 { get; set; }
167 public string? Text54 { get; set; }
168 public string? Text55 { get; set; }
169 public string? Text56 { get; set; }
170 public string? Text57 { get; set; }
171 public string? Text58 { get; set; }
172 public string? Text59 { get; set; }
173 public string? Text60 { get; set; }
174 public string? Text61 { get; set; }
175 public string? Text62 { get; set; }
176 public string? Text63 { get; set; }
177 public string? Text64 { get; set; }
178 public string? Text65 { get; set; }
179 public string? Text66 { get; set; }
180 public string? Text67 { get; set; }
181 public string? Text68 { get; set; }
182 public string? Text69 { get; set; }
183 public string? Text70 { get; set; }
184 public string? Text71 { get; set; }
185 public string? Text72 { get; set; }
186 public string? Text73 { get; set; }
187 public string? Text74 { get; set; }
188 public string? Text75 { get; set; }
189 public string? Text76 { get; set; }
190 public string? Text77 { get; set; }
191 public string? Text78 { get; set; }
192 public string? Text79 { get; set; }
193 public string? Text80 { get; set; }
194 public string? Text81 { get; set; }
195 public string? Text82 { get; set; }
196 public string? Text83 { get; set; }
197 public string? Text84 { get; set; }
198 public string? Text85 { get; set; }
199 public string? Text86 { get; set; }
200 public string? Text87 { get; set; }
201 public string? Text88 { get; set; }
202 public string? Text89 { get; set; }
203 public string? Text90 { get; set; }
204 public string? Text91 { get; set; }
205 public string? Text92 { get; set; }
206 public string? Text93 { get; set; }
207 public string? Text94 { get; set; }
208 public string? Text95 { get; set; }
209 public string? Text96 { get; set; }
210 public string? Text97 { get; set; }
211 public string? Text98 { get; set; }
212 public string? Text99 { get; set; }
213 public string? Text100 { get; set; }
214 public string? Text101 { get; set; }
215 public string? Text102 { get; set; }
216 public string? Text103 { get; set; }
217 public string? Text104 { get; set; }
218 public string? Text105 { get; set; }
219 public string? Text106 { get; set; }
220 public string? Text107 { get; set; }
221 public string? Text108 { get; set; }
222 public string? Text109 { get; set; }
223 public string? Text110 { get; set; }
224 public string? Text111 { get; set; }
225 public string? Text112 { get; set; }
226 public string? Text113 { get; set; }
227 public string? Text114 { get; set; }
228 public string? Text115 { get; set; }
229 public string? Text116 { get; set; }
230 public string? Text117 { get; set; }
231 public string? Text118 { get; set; }
232 public string? Text119 { get; set; }
233 public string? Text120 { get; set; }
234 public string? Text121 { get; set; }
235 public string? Text122 { get; set; }
236 public string? Text123 { get; set; }
237 public string? Text124 { get; set; }
238 public string? Text125 { get; set; }
239 public string? Text126 { get; set; }
240 public string? Text127 { get; set; }
241 public string? Text128 { get; set; }
242 public string? Text129 { get; set; }
243 public string? Text130 { get; set; }
244 public string? Text131 { get; set; }
245 public string? Text132 { get; set; }
246 public string? Text133 { get; set; }
247 public string? Text134 { get; set; }
248 public string? Text135 { get; set; }
249 public string? Text136 { get; set; }
250 public string? Text137 { get; set; }
251 public string? Text138 { get; set; }
252 public string? Text139 { get; set; }
253 public string? Text140 { get; set; }
254 public string? Text141 { get; set; }
255 public string? Text142 { get; set; }
256 public string? Text143 { get; set; }
257 public string? Text144 { get; set; }
258 public string? Text145 { get; set; }
259 public string? Text146 { get; set; }
260 public string? Text147 { get; set; }
261 public string? Text148 { get; set; }
262 public string? Text149 { get; set; }
263 public string? Text150 { get; set; }
264 public string? Text151 { get; set; }
265 public string? Text152 { get; set; }
266 public string? Text153 { get; set; }
267 public string? Text154 { get; set; }
268 public string? Text155 { get; set; }
269 public string? Text156 { get; set; }
270 public string? Text157 { get; set; }
271 public string? Text158 { get; set; }
272 public string? Text159 { get; set; }
273 public string? Text160 { get; set; }
274 public string? Text161 { get; set; }
275 public string? Text162 { get; set; }
276 public string? Text163 { get; set; }
277 public string? Text164 { get; set; }
278 public string? Text165 { get; set; }
279 }
280
281 public class EaiInteger
282 {
283 public int? Integer1 { get; set; }
284 public int? Integer2 { get; set; }
285 public int? Integer3 { get; set; }
286 public int? Integer4 { get; set; }
287 public int? Integer5 { get; set; }
288 public int? Integer6 { get; set; }
289 public int? Integer7 { get; set; }
290 public int? Integer8 { get; set; }
291 public int? Integer9 { get; set; }
292 public int? Integer10 { get; set; }
293 public int? Integer11 { get; set; }
294 public int? Integer12 { get; set; }
295 public int? Integer13 { get; set; }
296 public int? Integer14 { get; set; }
297 public int? Integer15 { get; set; }
298 public int? Integer16 { get; set; }
299 public int? Integer17 { get; set; }
300 public int? Integer18 { get; set; }
301 public int? Integer19 { get; set; }
302 public int? Integer20 { get; set; }
303 public int? Integer21 { get; set; }
304 public int? Integer22 { get; set; }
305 public int? Integer23 { get; set; }
306 public int? Integer24 { get; set; }
307 public int? Integer25 { get; set; }
308 public int? Integer26 { get; set; }
309 public int? Integer27 { get; set; }
310 public int? Integer28 { get; set; }
311 public int? Integer29 { get; set; }
312 public int? Integer30 { get; set; }
313 public int? Integer31 { get; set; }
314 public int? Integer32 { get; set; }
315 public int? Integer33 { get; set; }
316 public int? Integer34 { get; set; }
317 public int? Integer35 { get; set; }
318 public int? Integer36 { get; set; }
319 public int? Integer37 { get; set; }
320 public int? Integer38 { get; set; }
321 public int? Integer39 { get; set; }
322 public int? Integer40 { get; set; }
323 public int? Integer41 { get; set; }
324 public int? Integer42 { get; set; }
325 public int? Integer43 { get; set; }
326 public int? Integer44 { get; set; }
327 public int? Integer45 { get; set; }
328 public int? Integer46 { get; set; }
329 public int? Integer47 { get; set; }
330 public int? Integer48 { get; set; }
331 public int? Integer49 { get; set; }
332 public int? Integer50 { get; set; }
333 }
334
335 public class EaiDecimal
336 {
337 public decimal? Decimal1 { get; set; }
338 public decimal? Decimal2 { get; set; }
339 public decimal? Decimal3 { get; set; }
340 public decimal? Decimal4 { get; set; }
341 public decimal? Decimal5 { get; set; }
342 public decimal? Decimal6 { get; set; }
343 public decimal? Decimal7 { get; set; }
344 public decimal? Decimal8 { get; set; }
345 public decimal? Decimal9 { get; set; }
346 public decimal? Decimal10 { get; set; }
347 public decimal? Decimal11 { get; set; }
348 public decimal? Decimal12 { get; set; }
349 public decimal? Decimal13 { get; set; }
350 public decimal? Decimal14 { get; set; }
351 public decimal? Decimal15 { get; set; }
352 public decimal? Decimal16 { get; set; }
353 public decimal? Decimal17 { get; set; }
354 public decimal? Decimal18 { get; set; }
355 public decimal? Decimal19 { get; set; }
356 public decimal? Decimal20 { get; set; }
357 public decimal? Decimal21 { get; set; }
358 public decimal? Decimal22 { get; set; }
359 public decimal? Decimal23 { get; set; }
360 public decimal? Decimal24 { get; set; }
361 public decimal? Decimal25 { get; set; }
362 public decimal? Decimal26 { get; set; }
363 public decimal? Decimal27 { get; set; }
364 public decimal? Decimal28 { get; set; }
365 public decimal? Decimal29 { get; set; }
366 public decimal? Decimal30 { get; set; }
367 public decimal? Decimal31 { get; set; }
368 public decimal? Decimal32 { get; set; }
369 public decimal? Decimal33 { get; set; }
370 public decimal? Decimal34 { get; set; }
371 public decimal? Decimal35 { get; set; }
372 public decimal? Decimal36 { get; set; }
373 public decimal? Decimal37 { get; set; }
374 public decimal? Decimal38 { get; set; }
375 public decimal? Decimal39 { get; set; }
376 public decimal? Decimal40 { get; set; }
377 }
378}