Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GET /interactions/{guid}/content/{contentKey} endpoint enables you to get a single interaction content file after specifying the interaction GUID and the content key.

...

Authorization scopes supported:

ScopeAccess granted
interaction-content:readEntire endpoint

Parameters

...

The endpoint accepts the following path parameters:

guid

Type

Required

Example

StringTrue2480fc2c-bbd7-427c-9439-02f76583aef5

The unique identifier of the interaction you want to get content for.

contentKey

Type

Required

Example

StringTruecallRecording

...

  • callRecording. The call recording files in audio/wav format.
  • transcript. The transcript of a call recording in application/json format.
  • chatTranscript. The transcript of a chat in application/json format.
  • attachment. The attachment file in application/json format.
  • categorizationResult. The categorization result of the transcript in application/json format.
  • ivrAudioRecording. The IVR audio recording files in audio/wav format.
  • Unique identifiers. To get

    a voicemail, a screen recording, or an audio recording collected by the IVR Data Collector,

    other interaction content, you must provide the unique identifier of the specific

    voicemail, screen recording, or audio recording

    content you want to get. For example, 017f2106-ff1b-8d35-89e5-1e01b327a159

    . (

    . Unique identifiers are returned by the GET /interactions and GET /interactions/{guid} endpoints. Interaction content that is identified by unique identifier is:

    • Audio recordings collected by the IVR Data Collector. Content is returned in video file format.

    • Voicemails. Content is returned in WAV format. Identifiers for older voicemails may be in the format voicemail-123 where 123 is the ID of the agent who the voicemail is for.

    ) Unique identifiers for voicemails, screen recordings, and audio recordings are returned by the GET /interactions and GET /interactions/{guid} endpoints
    • Screen recordings. Content is returned in video file format.

    • Video and screen share (Visual Engagement) recordings. Content is returned in video file format.

Header parameters

range

Type

Required

Example

StringFalse
bytes=0-1023

...

  • callRecording (audio/wav)
  • transcript, chatTranscriptcategorizationResult, attachment (application/json)
  • screenRecording (video/webm)
  • voicemail (audio/wav)
  • ivrAudioRecording (audio/wav)
  • videoRecording (video)

For information about successful responses, see Success response code and parameters in Responses (Interaction Content API).

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue