The GET /interactions/{guid} endpoint returns detailed information about a single interaction.
Header parameters in Requests (Insights Stats API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
stats | Entire endpoint |
The endpoint accepts the following path parameter:
guid| Type | Required | Example |
|---|---|---|
| String | True | 016f3105-0854-43e2-9d2a-33ef02aff410 |
The unique identifier for the interaction.
curl -L -X GET "https://***.api.newvoicemedia.com/stats/interactions/9b0e5ced-514f-4415-82cf-2d16955965d7" \ -H "Authorization: bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v3+json" |
The response to the GET /interactions/{guid} endpoint contains a singe interaction object.
A successful request returns a 200 Success code with a JSON object in the response body.
{
"status": "Completed",
"medium": "Phone",
"mediumManager": "VCC",
"start": "2020-01-07T16:50:59.899Z",
"guid": "016f7e44-7556-4747-9982-de543dfbe27f",
"conversationGuid": "2b60783a-c74c-4938-b843-ce496c54ef81",
"duration": 83340,
"direction": "Inbound",
"serviceName": "Report Gp 2",
"connectTo": "1234567890",
"connectFrom": "0987654321",
"categorizedAt": "2020-01-07T16:56:59.899Z",
"interactionPlanMapping": {
"addressName": "Main Support Number",
"mappingName": "Mapping1",
"interactionPlanName": "Customer Support Plan",
"reportingGroup": "Report Gp 2"
},
"channels": [
{
"guid": "016f7e44-7556-4747-9982-de543dfbe27f",
"offset": 0,
"duration": 81328,
"endReason": "Released",
"integrationType": null,
"party": {
"id": null,
"role": "External",
"touchpoint": "01256700817"
},
"events": [
{
"type": "Ringing",
"offset": 0,
"name": null,
"duration": 0,
"properties": null
},
{
"type": "Connected",
"offset": 0,
"name": null,
"duration": 81328,
"properties": null
},
{
"type": "InteractionPlan",
"offset": 307,
"name": "Customer Support Plan",
"duration": 81021,
"properties": {
"reportingGroup": "Report Gp 2"
}
},
{
"type": "Applet",
"offset": 362,
"name": "Welcome",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 437,
"name": "AnnouncementA",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 488,
"name": "AnnouncementB",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 553,
"name": "AnnouncementC",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 606,
"name": "AnnouncementD",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 670,
"name": "AnnouncementE",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 721,
"name": "AnnouncementF",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 785,
"name": "AnnouncementG",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 849,
"name": "AnnouncementH",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 910,
"name": "AnnouncementI",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 982,
"name": "AnnouncementJ",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1041,
"name": "AnnouncementK",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1097,
"name": "AnnouncementL",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1161,
"name": "AnnouncementM",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1232,
"name": "AnnouncementN",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1589,
"name": "AnnouncementO",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1678,
"name": "AnnouncementP",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1740,
"name": "AnnouncementQ",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1795,
"name": "AnnouncementR",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1846,
"name": "AnnouncementS",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1898,
"name": "AnnouncementT",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 1962,
"name": "AnnouncementU",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2018,
"name": "AnnouncementV",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2088,
"name": "AnnouncementW",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2143,
"name": "AnnouncementX",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2209,
"name": "AnnouncementY",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2260,
"name": "AnnouncementZ",
"duration": 0,
"properties": {
"appletType": "Announcement"
}
},
{
"type": "Applet",
"offset": 2315,
"name": "Call Record",
"duration": 0,
"properties": {
"appletType": "CallRecording"
}
},
{
"type": "Applet",
"offset": 10834,
"name": "MainMenu1",
"duration": 0,
"properties": {
"appletType": "Menu"
}
},
{
"type": "Applet",
"offset": 12681,
"name": "SkillTag1",
"duration": 0,
"properties": {
"appletType": "SkillTagger"
}
},
{
"type": "Applet",
"offset": 13083,
"name": "ACD1",
"duration": 0,
"properties": {
"appletType": "ACD"
}
},
{
"type": "Queue",
"offset": 13164,
"name": "ACD1",
"duration": 7140,
"properties": {
"interactionPlan": "1234567890",
"interactionPlanName": "Customer Support Plan",
"presentedSkills": [
"Billing"
],
"result": "Delivered"
}
},
{
"type": "CallRecording",
"offset": 20322,
"name": null,
"duration": 61006,
"properties": null
}
]
},
{
"guid": "6608465f-46fc-4d51-85f7-804a306fcc2b",
"offset": 14087,
"duration": 69253,
"endReason": "Released",
"integrationType": null,
"party": {
"id": "01",
"role": "Agent",
"touchpoint": "01122334455"
},
"events": [
{
"type": "Ringing",
"offset": 14087,
"name": null,
"duration": 6217,
"properties": null
},
{
"type": "Connected",
"offset": 20304,
"name": null,
"duration": 59165,
"properties": null
},
{
"type": "CallRecording",
"offset": 20322,
"name": null,
"duration": 59147,
"properties": null
},
{
"type": "Wrap",
"offset": 79469,
"name": null,
"duration": 3871,
"properties": null
},
{
"type": "Disposition",
"offset": 79470,
"name": null,
"duration": 0,
"properties": {
"disposition": "CallBack"
}
},
{
"type": "CallRating",
"offset": 79471,
"name": null,
"duration": 0,
"properties": {
"classification": "3"
}
}
]
}
]
} |
A single interaction contains the following parameters: