–Get multiple interactions

The GET /interactions?calls={guids} endpoint returns categorisation and call time breakdown data for up to 50 interactions. Optionally, it can also return the transcription.

Parameters

Query string parameters

calls

Type Required Example
String True 0164705c-c206-dce9-d61a-9899855326a0,0164db4a-0f05-49ba-a963-78be15c69a82,01651953-4aab-ccb9-80d4-92152cd10691

A comma-separated list of call GUIDs.

transcript

Type Required Example
Boolean False true

A flag indicating whether you want to receive the transcript information for the recordings. Defaults to false.

Responses

A response to a valid GET /interactions?calls={guids} request contains information for up to 50 calls.

Example v1 response

[
{
    "categories": [
        {
            "category": "Politeness",
            "subcategories": [
                "greeting"
            ]
        }
    ],
    "guid": "0164705c-c206-dce9-d61a-9899855326a0",
    "status": "processed",
    "confidence": "Low",
    "callTimeBreakDown": {
        "agent": 5,
        "customer": 1,
        "silence": 4,
        "crossTalk": 0
    },
    "transcript": "Case.\nHi, and yeah, just just a call here. Thank you bye."
},
{
    ... record 2
},
...
{
    ... record n
}
]

Example v2 response

[
{
    "categories": [
        {
            "category": "Politeness",
            "categories": [
                {
                    "name": "Greeting",
                    "matches": "1"
                }
            ]
        }
    ],
    "guid": "0164705c-c206-dce9-d61a-9899855326a0",
    "status": "processed",
    "confidence": "Low",
    "callTimeBreakDown": {
        "agent": 5,
        "customer": 1,
        "silence": 4,
        "crossTalk": 0
    },
    "transcript": "Case.\nHi, and yeah, just just a call here. Thank you bye."
},
{
    ... record 2
},
...
{
    ... record n
}
]

The structure of individual items in the response matches the format of a single item in a response to a request for a single interaction. For information, see Interaction item.