Upload Media

Uploads an audio file interaction into storage for processing.

Param name "file"

Audio file uploaded from client

Valid Audio File Extensions:

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

Valid Chat File Extensions:

  • .tar
  • .zip

Param name "metadata"

JSON dictionary containing multiple metadata fields about the Audio File:

Required Fields:
    - FileName:
        Path containing file name and extension. Subdirectories specifying a more exact path may be prepended to the file name.
        Examples:
            -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.mp3"
            -- Without subdirectories: "filename.mp3"
    - UploadType:
        Type indicating if you are uploding a chat or audio file.
        Examples:
            -- "Chat"
            -- "Audio"

Optional Fields: 
    - CallDirection: 
        Direction of the interaction's call to or from the call center. 
        Examples: 
            -- "Inbound" 
            -- "Outbound" 
    - Name: 
        Name associated with interaction. 
        Example: 
            -- "Alice" 
    - Phone: 
        Phone number associated with interaction. 
        Example: 
            --"800-555-5555" 
    - Email: 
        Email address associated with interaction. 
        Example: 
            --"[email protected]" 
    - AgentFirstName: 
        Agent's First Name associated with interaction. 
        Example: 
            --"James" 
    - AgentLastName: 
        Agent's Last Name associated with interaction. 
        Example: 
            --"Bond" 
    - AgentCode: 
        Agent Code for associating agent already in system with interaction. 
        Example: 
            --"007" 
    - InteractionDate: 
        Date on which interaction occured. 
        ISO-8601 Examples: 
        --UTC datetime: "2022-03-18T21:52:26" 
        --UTC datetime with milliseconds: "2022-03-18T21:52:26.8816090Z" 
        --UTC date only: "2022-03-19" 
        --datetime with timezone: "2022-03-18T17:56:09.8683110-04:00" 
    - ExtendedMetadata: [Deprecated - ("Use ExtendedMetadataValues")]
        Array of Dictionaries of key values associated with interaction 
        Examples: 
        -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }]
    - ExtendedMetadataValues: 
        Dictionary of key values associated with interaction 
        Examples: 
        -- { "Data": "Example Data" }, { "Data2": "Example Data 2" }, { "ExampleKey": "Example Value" }
    - HierarchyId: 
        Id of hierarchy to associate with this interaction 
        Example: 
        -- "00000000-0000-0000-0000-000000000002" 
    - HierarchyCode: 
        Internal Organization Code for associating hierarchy with this interaction 
        Example: 
        -- "Accounting"
    - ApplyHierarchyToAgent: 
        If we want the hierarchy that is passed in to also be applied to the agent then true 
        Example: 
        -- true
    - LocaleId:
        The LocaleId for the language that the interaction is in. We currently support
        LocaleIds 1033 (English) and 2058 (Spanish).
    - ClientCallId:
        External Organization Code for associating source of telephony
        Example:
        -- "5CD1S"
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!