Get specific interaction by its GUID

The GET /interactions/{guid} endpoint enables you to retrieve a specific interaction by specifying its unique identifier. The endpoint returns a specific interaction. The endpoint returns only the interactions that contain interaction content.

Headers

Header parameters in Requests (Interaction Content API) apply to this endpoint.

Authorization scopes supported:

Parameters

The endpoint accepts the following path parameters:

guid

A globally unique identifier of the interaction you want to search for.

Request

Request a single interaction

curl -L -X GET "https://***.api.newvoicemedia.com/interaction-content/interactions/2480fc2c-bbd7-427c-9439-02f76583aef5" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v3+json" \

Responses

Responses to the endpoint returns the presences of all the users.

Successful response

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

Example responses

{
  "guid": "2480fc2c-bbd7-427c-9439-02f76583aef5",
  "start": "2020-02-16T14:11:56Z",
  "connectFrom": "+14154204204",
  "connectTo": "22222",
  "direction": "inbound",
  "handlingAgents": [
    {
      "id": "1342"
    }
  ],
  "content": [
    {
      "contentKey": "callRecording",
      "type": "callRecording",
      "contentType": "audio/wav",
      "contentLength": 359,
      "lastModified": "2020-02-16T14:19:35Z",
      "properties": {}
    },
    {
      "contentKey": "fbebd00a-9017-48d3-ad5c-156f4c45024e",
      "type": "voicemail",
      "contentType": "audio/wav",
      "contentLength": 121,
      "owningAgent": {
        "id": "1342"
      },
      "lastModified": "2020-02-16T14:19:01Z",
      "properties": {}
    }, 
 	{
      "contentKey": "ad76a807-3e21-41c6-992e-dc9865ffcc9d",
      "type": "ivrAudioRecording",
      "contentType": "audio/wav",
      "contentLength": 100,
      "owningInteractionPlan": {
        "id": "816f1144-ac27-4bba-a280-cc66"
      },
      "lastModified": "2020-02-16T14:20:01Z",
      "properties": {}
    },
    {
      "contentKey": "73c986b3-c704-4f8d-ac3c-53205772a003",
      "type": "chatTranscript",
      "contentType": "application/json",
      "contentLength": 906,
      "lastModified": "2024-02-01T13:31:31Z",
      "properties": {
        "version": {
          "value": 1
        }
      }
    }
  ]
}

where:

• guid. The unique identifier of the interaction.
• start. The interaction start date.
• connectFrom. The address of the party that initiated the interaction. For a phone call connectFrom is their phone number.
• connectTo. The address of the party that was being contacted within the interaction. For a phone call connectTo is their phone number.
• direction. The direction of the interaction. Can be:
  • inbound. Interaction was initiated by a customer to interact with a VCC agent
  • outbound. Interaction was initiated by a VCC agent to interact with a customer
• handlingAgents. A JSON array with identifiers of the agents involved in the interaction.
  • id. The unique identifier of each handling agent.
• content. A JSON array with content attached to this interaction. 
  • contentKey. The key of the content type you can retrieve from a given interaction using the GET ‘/interactions/{guid}/content/{contentKey}’ endpoint.
  • type. The type of the content. Supported types are:
    • callRecording
    • screenRecording
    • voicemail
    • transcript
    • chatTranscript
    • categorizationResult
    • sentimentSummary
    • attachment
    • ivrAudioRecording
    • videoRecording
    • conversationSummary
    • interactionLog
  • contentType. The media type of the interaction content such as audio/wav or application/json.
  • contentLength. The length of the content expressed in bytes.
  • owningAgent. The identifier of the agent that owns the content. Returned only for some types of content —  where type is voicemail.
    • id. The unique identifier of the owning agent.
  • owningInteractionPlan. The identifier of the interaction plan that was used to create the content. Returned only for some types of content —  where type is ivrAudioRecording.
    • id. The unique identifier of the interaction plan.
  • lastModified. The date/time (in UTC) that the interaction content was last modified.
  • properties. Depending on the content type, additional properties may be returned.
    • version. The version of the content type returned for only some types of content.
      • value. The version of the content type.