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.
namespace ElevateAI { internal class EaiMetadata { public string? Category { get; set; } public string? Direction { get; set; } public string? Recorded { get; set; } public EaiMetaAudio? Audio { get; set; } public EaiMetaAgent? Agent { get; set; } public EaiMetaSite? Site { get; set; } public EaiMetaCustomer? Customer { get; set; } public EaiMetaCustom? Custom { get; set; } } public class EaiMetaAudio { public string? Extension { get; set; } public string? DNIS { get; set; } } public class EaiMetaAgent { public string? Id { get; set; } public string? Name { get; set; } public EaiMetaSupervisor? Supervisor { get; set; } public EaiMetaGroup? Group { get; set; } } public class EaiMetaSupervisor { public string? Id { get; set; } public string? Name { get; set; } } public class EaiMetaGroup { public string? Id { get; set; } public string? Name { get; set; } } public class EaiMetaSite { public string? Id { get; set; } public string? Name { get; set; } } public class EaiMetaCustomer { public string? Id { get; set; } public string? Name { get; set; } public string? City { get; set; } public string? State { get; set; } } public class EaiMetaCustom { public EaiDateTime? DateTimes { get; set; } public EaiText? Texts { get; set; } public EaiInteger? Integers { get; set; } public EaiDecimal? Decimals { get; set; } } public class EaiDateTime { public DateTime? DateTime1 { get; set; } public DateTime? DateTime2 { get; set; } public DateTime? DateTime3 { get; set; } public DateTime? DateTime4 { get; set; } public DateTime? DateTime5 { get; set; } public DateTime? DateTime6 { get; set; } public DateTime? DateTime7 { get; set; } public DateTime? DateTime8 { get; set; } public DateTime? DateTime9 { get; set; } public DateTime? DateTime10 { get; set; } public DateTime? DateTime11 { get; set; } public DateTime? DateTime12 { get; set; } public DateTime? DateTime13 { get; set; } public DateTime? DateTime14 { get; set; } public DateTime? DateTime15 { get; set; } public DateTime? DateTime16 { get; set; } public DateTime? DateTime17 { get; set; } public DateTime? DateTime18 { get; set; } public DateTime? DateTime19 { get; set; } public DateTime? DateTime20 { get; set; } public DateTime? DateTime21 { get; set; } public DateTime? DateTime22 { get; set; } public DateTime? DateTime23 { get; set; } public DateTime? DateTime24 { get; set; } public DateTime? DateTime25 { get; set; } public DateTime? DateTime26 { get; set; } public DateTime? DateTime27 { get; set; } public DateTime? DateTime28 { get; set; } public DateTime? DateTime29 { get; set; } public DateTime? DateTime30 { get; set; } public DateTime? DateTime31 { get; set; } public DateTime? DateTime32 { get; set; } public DateTime? DateTime33 { get; set; } public DateTime? DateTime34 { get; set; } public DateTime? DateTime35 { get; set; } public DateTime? DateTime36 { get; set; } public DateTime? DateTime37 { get; set; } public DateTime? DateTime38 { get; set; } public DateTime? DateTime39 { get; set; } public DateTime? DateTime40 { get; set; } public DateTime? DateTime41 { get; set; } public DateTime? DateTime42 { get; set; } public DateTime? DateTime43 { get; set; } public DateTime? DateTime44 { get; set; } public DateTime? DateTime45 { get; set; } } public class EaiText { public string? Text1 { get; set; } public string? Text2 { get; set; } public string? Text3 { get; set; } public string? Text4 { get; set; } public string? Text5 { get; set; } public string? Text6 { get; set; } public string? Text7 { get; set; } public string? Text8 { get; set; } public string? Text9 { get; set; } public string? Text10 { get; set; } public string? Text11 { get; set; } public string? Text12 { get; set; } public string? Text13 { get; set; } public string? Text14 { get; set; } public string? Text15 { get; set; } public string? Text16 { get; set; } public string? Text17 { get; set; } public string? Text18 { get; set; } public string? Text19 { get; set; } public string? Text20 { get; set; } public string? Text21 { get; set; } public string? Text22 { get; set; } public string? Text23 { get; set; } public string? Text24 { get; set; } public string? Text25 { get; set; } public string? Text26 { get; set; } public string? Text27 { get; set; } public string? Text28 { get; set; } public string? Text29 { get; set; } public string? Text30 { get; set; } public string? Text31 { get; set; } public string? Text32 { get; set; } public string? Text33 { get; set; } public string? Text34 { get; set; } public string? Text35 { get; set; } public string? Text36 { get; set; } public string? Text37 { get; set; } public string? Text38 { get; set; } public string? Text39 { get; set; } public string? Text40 { get; set; } public string? Text41 { get; set; } public string? Text42 { get; set; } public string? Text43 { get; set; } public string? Text44 { get; set; } public string? Text45 { get; set; } public string? Text46 { get; set; } public string? Text47 { get; set; } public string? Text48 { get; set; } public string? Text49 { get; set; } public string? Text50 { get; set; } public string? Text51 { get; set; } public string? Text52 { get; set; } public string? Text53 { get; set; } public string? Text54 { get; set; } public string? Text55 { get; set; } public string? Text56 { get; set; } public string? Text57 { get; set; } public string? Text58 { get; set; } public string? Text59 { get; set; } public string? Text60 { get; set; } public string? Text61 { get; set; } public string? Text62 { get; set; } public string? Text63 { get; set; } public string? Text64 { get; set; } public string? Text65 { get; set; } public string? Text66 { get; set; } public string? Text67 { get; set; } public string? Text68 { get; set; } public string? Text69 { get; set; } public string? Text70 { get; set; } public string? Text71 { get; set; } public string? Text72 { get; set; } public string? Text73 { get; set; } public string? Text74 { get; set; } public string? Text75 { get; set; } public string? Text76 { get; set; } public string? Text77 { get; set; } public string? Text78 { get; set; } public string? Text79 { get; set; } public string? Text80 { get; set; } public string? Text81 { get; set; } public string? Text82 { get; set; } public string? Text83 { get; set; } public string? Text84 { get; set; } public string? Text85 { get; set; } public string? Text86 { get; set; } public string? Text87 { get; set; } public string? Text88 { get; set; } public string? Text89 { get; set; } public string? Text90 { get; set; } public string? Text91 { get; set; } public string? Text92 { get; set; } public string? Text93 { get; set; } public string? Text94 { get; set; } public string? Text95 { get; set; } public string? Text96 { get; set; } public string? Text97 { get; set; } public string? Text98 { get; set; } public string? Text99 { get; set; } public string? Text100 { get; set; } public string? Text101 { get; set; } public string? Text102 { get; set; } public string? Text103 { get; set; } public string? Text104 { get; set; } public string? Text105 { get; set; } public string? Text106 { get; set; } public string? Text107 { get; set; } public string? Text108 { get; set; } public string? Text109 { get; set; } public string? Text110 { get; set; } public string? Text111 { get; set; } public string? Text112 { get; set; } public string? Text113 { get; set; } public string? Text114 { get; set; } public string? Text115 { get; set; } public string? Text116 { get; set; } public string? Text117 { get; set; } public string? Text118 { get; set; } public string? Text119 { get; set; } public string? Text120 { get; set; } public string? Text121 { get; set; } public string? Text122 { get; set; } public string? Text123 { get; set; } public string? Text124 { get; set; } public string? Text125 { get; set; } public string? Text126 { get; set; } public string? Text127 { get; set; } public string? Text128 { get; set; } public string? Text129 { get; set; } public string? Text130 { get; set; } public string? Text131 { get; set; } public string? Text132 { get; set; } public string? Text133 { get; set; } public string? Text134 { get; set; } public string? Text135 { get; set; } public string? Text136 { get; set; } public string? Text137 { get; set; } public string? Text138 { get; set; } public string? Text139 { get; set; } public string? Text140 { get; set; } public string? Text141 { get; set; } public string? Text142 { get; set; } public string? Text143 { get; set; } public string? Text144 { get; set; } public string? Text145 { get; set; } public string? Text146 { get; set; } public string? Text147 { get; set; } public string? Text148 { get; set; } public string? Text149 { get; set; } public string? Text150 { get; set; } public string? Text151 { get; set; } public string? Text152 { get; set; } public string? Text153 { get; set; } public string? Text154 { get; set; } public string? Text155 { get; set; } public string? Text156 { get; set; } public string? Text157 { get; set; } public string? Text158 { get; set; } public string? Text159 { get; set; } public string? Text160 { get; set; } public string? Text161 { get; set; } public string? Text162 { get; set; } public string? Text163 { get; set; } public string? Text164 { get; set; } public string? Text165 { get; set; } } public class EaiInteger { public int? Integer1 { get; set; } public int? Integer2 { get; set; } public int? Integer3 { get; set; } public int? Integer4 { get; set; } public int? Integer5 { get; set; } public int? Integer6 { get; set; } public int? Integer7 { get; set; } public int? Integer8 { get; set; } public int? Integer9 { get; set; } public int? Integer10 { get; set; } public int? Integer11 { get; set; } public int? Integer12 { get; set; } public int? Integer13 { get; set; } public int? Integer14 { get; set; } public int? Integer15 { get; set; } public int? Integer16 { get; set; } public int? Integer17 { get; set; } public int? Integer18 { get; set; } public int? Integer19 { get; set; } public int? Integer20 { get; set; } public int? Integer21 { get; set; } public int? Integer22 { get; set; } public int? Integer23 { get; set; } public int? Integer24 { get; set; } public int? Integer25 { get; set; } public int? Integer26 { get; set; } public int? Integer27 { get; set; } public int? Integer28 { get; set; } public int? Integer29 { get; set; } public int? Integer30 { get; set; } public int? Integer31 { get; set; } public int? Integer32 { get; set; } public int? Integer33 { get; set; } public int? Integer34 { get; set; } public int? Integer35 { get; set; } public int? Integer36 { get; set; } public int? Integer37 { get; set; } public int? Integer38 { get; set; } public int? Integer39 { get; set; } public int? Integer40 { get; set; } public int? Integer41 { get; set; } public int? Integer42 { get; set; } public int? Integer43 { get; set; } public int? Integer44 { get; set; } public int? Integer45 { get; set; } public int? Integer46 { get; set; } public int? Integer47 { get; set; } public int? Integer48 { get; set; } public int? Integer49 { get; set; } public int? Integer50 { get; set; } } public class EaiDecimal { public decimal? Decimal1 { get; set; } public decimal? Decimal2 { get; set; } public decimal? Decimal3 { get; set; } public decimal? Decimal4 { get; set; } public decimal? Decimal5 { get; set; } public decimal? Decimal6 { get; set; } public decimal? Decimal7 { get; set; } public decimal? Decimal8 { get; set; } public decimal? Decimal9 { get; set; } public decimal? Decimal10 { get; set; } public decimal? Decimal11 { get; set; } public decimal? Decimal12 { get; set; } public decimal? Decimal13 { get; set; } public decimal? Decimal14 { get; set; } public decimal? Decimal15 { get; set; } public decimal? Decimal16 { get; set; } public decimal? Decimal17 { get; set; } public decimal? Decimal18 { get; set; } public decimal? Decimal19 { get; set; } public decimal? Decimal20 { get; set; } public decimal? Decimal21 { get; set; } public decimal? Decimal22 { get; set; } public decimal? Decimal23 { get; set; } public decimal? Decimal24 { get; set; } public decimal? Decimal25 { get; set; } public decimal? Decimal26 { get; set; } public decimal? Decimal27 { get; set; } public decimal? Decimal28 { get; set; } public decimal? Decimal29 { get; set; } public decimal? Decimal30 { get; set; } public decimal? Decimal31 { get; set; } public decimal? Decimal32 { get; set; } public decimal? Decimal33 { get; set; } public decimal? Decimal34 { get; set; } public decimal? Decimal35 { get; set; } public decimal? Decimal36 { get; set; } public decimal? Decimal37 { get; set; } public decimal? Decimal38 { get; set; } public decimal? Decimal39 { get; set; } public decimal? Decimal40 { get; set; } } }