Audio Interaction Metadata

Audio Interaction Metadata is some of the most important information that we collect.

Below you will see the structure of such metadata that you can provide about an interaction when uploading via the /Media/Upload route.

{
  "fileName": string,
  "uploadType": "Audio",
  "callDirection": string,
  "name": string,
  "phone": string,
  "email": string,
  "agentFirstName": string,
  "agentLastName": string,
  "agentCode": string,
  "localeId": int,
  "hierarchyId": Guid,
  "hierarchyCode": string,
  "extendedMetadata": List<Dictionary<string, object>>,
  "interactionDate": DateTime
}

Example Metadata

{
  "fileName": "calls/2023-06-21_A89CKAL13.mp3",
  "uploadType": "Audio",
  "callDirection": "Inbound",
  "name": "John Doe",
  "phone": "3177131371",
  "email": "[email protected]",
  "agentFirstName": "Lorem",
  "agentLastName": "Ipsum",
  "agentCode": "AUT3391",
  "localeId": 1033,
  "hierarchyId": "7d705f35-fb4f-461b-9268-728135e574a9",
  "hierarchyCode": "VP_Lvl_1",
  "extendedMetadata": [
    {
      "key1": "value1",
     	"key2": "value2"
    },
  ],
  "interactionDate": "2022-03-18T21:52:26"
}

Conversation Metadata vs. Extended Metadata

The extendedMetadata field in the interaction metadata object allows you to store additional, custom metadata beyond the standard model. It accepts a list of key-value pairs, giving you flexibility to capture any context-specific attributes without relying on a fixed schema.

Example

"extendedMetadata": [
  { "callerType": "Physician Office" },
  { "productCode": "XYZ123" },
  { "callbackRequested": true }
]

📘

Use Extended Metadata to enrich conversation with business-specific data for routing, reporting, or integration needs.


Accepted Audio File Types

We accept 6 distinct audio file types for processing which are listed below:

  • wav
  • mp3
  • mp4
  • ogg
  • opus
  • m4a

What’s Next