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.
...
Authorization scopes supported:
Scope | Access granted |
---|---|
interaction-content:read | Entire endpoint |
Parameters
The endpoint accepts the following path parameters:
guid
Type | Required | Example |
---|---|---|
String | True | 2480fc2c-bbd7-427c-9439-02f76583aef5 |
...
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
- attachment
- ivrAudioRecording
- videoRecording
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 — wheretype
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 — wheretype
is ivrAudioRecording.id
. The unique identifier of the interaction plan.
lastModified
. The date/time (in UTC) that the interaction content was last modified.
...