GET Calls/{callId}/Annotations

Get annotations for specific call

Request Information

URI Parameters

NameDescriptionTypeAdditional information
callId

integer

Required

GroupByKWG

Do grouping by keywordgroup

boolean
ExcludeByWorkflow

Hide annotations excluded by workflow

boolean
FindAnnotationNestedCondition

json representation of nested search

string
AnnotationSource

Collection of AnnotationSource
AnnotationSourcesShouldMatch

boolean

Body Parameters

Response Information

Resource Description

CallsGetAnnotationsResponse
NameDescriptionTypeAdditional information
GroupByKWG

Grouped by keyword group?

boolean
ExcludeByWorkflow

Exclude by workflow?

boolean
Annotations

Annotations

Collection of Annotation
KeywordGroups

Keywordgroups

Collection of CallsGetAnnotationsKeywordGroup

Response Formats

application/json, text/json

Sample:
{
  "GroupByKWG": true,
  "ExcludeByWorkflow": true,
  "Annotations": [
    {
      "CallId": 1,
      "ChannelId": 2,
      "CreatedBy": 3,
      "EndTime": "2018-11-20T22:35:31.5466667+01:00",
      "ExcludedByWorkflow": true,
      "JobInstanceId": 6,
      "KeywordGroupId": 7,
      "ModifiedBy": 8,
      "OccurenceType": 0,
      "Processed": true,
      "RecordingId": 10,
      "Source": 0,
      "SpeechJobId": 11,
      "StartTime": "2018-11-20T22:35:31.5466667+01:00",
      "Type": 0,
      "Value": 13.1,
      "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
      "DateModified": "2018-11-20T22:35:31.5466667+01:00",
      "Description": "sample string 16",
      "Id": 17,
      "Name": "sample string 18"
    },
    {
      "CallId": 1,
      "ChannelId": 2,
      "CreatedBy": 3,
      "EndTime": "2018-11-20T22:35:31.5466667+01:00",
      "ExcludedByWorkflow": true,
      "JobInstanceId": 6,
      "KeywordGroupId": 7,
      "ModifiedBy": 8,
      "OccurenceType": 0,
      "Processed": true,
      "RecordingId": 10,
      "Source": 0,
      "SpeechJobId": 11,
      "StartTime": "2018-11-20T22:35:31.5466667+01:00",
      "Type": 0,
      "Value": 13.1,
      "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
      "DateModified": "2018-11-20T22:35:31.5466667+01:00",
      "Description": "sample string 16",
      "Id": 17,
      "Name": "sample string 18"
    }
  ],
  "KeywordGroups": [
    {
      "KeywordGroupID": 1,
      "ChannelId": 2,
      "StartTime": "2018-11-20T22:35:31.5466667+01:00",
      "EndTime": "2018-11-20T22:35:31.5466667+01:00",
      "Annotations": [
        {
          "CallId": 1,
          "ChannelId": 2,
          "CreatedBy": 3,
          "EndTime": "2018-11-20T22:35:31.5466667+01:00",
          "ExcludedByWorkflow": true,
          "JobInstanceId": 6,
          "KeywordGroupId": 7,
          "ModifiedBy": 8,
          "OccurenceType": 0,
          "Processed": true,
          "RecordingId": 10,
          "Source": 0,
          "SpeechJobId": 11,
          "StartTime": "2018-11-20T22:35:31.5466667+01:00",
          "Type": 0,
          "Value": 13.1,
          "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
          "DateModified": "2018-11-20T22:35:31.5466667+01:00",
          "Description": "sample string 16",
          "Id": 17,
          "Name": "sample string 18"
        },
        {
          "CallId": 1,
          "ChannelId": 2,
          "CreatedBy": 3,
          "EndTime": "2018-11-20T22:35:31.5466667+01:00",
          "ExcludedByWorkflow": true,
          "JobInstanceId": 6,
          "KeywordGroupId": 7,
          "ModifiedBy": 8,
          "OccurenceType": 0,
          "Processed": true,
          "RecordingId": 10,
          "Source": 0,
          "SpeechJobId": 11,
          "StartTime": "2018-11-20T22:35:31.5466667+01:00",
          "Type": 0,
          "Value": 13.1,
          "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
          "DateModified": "2018-11-20T22:35:31.5466667+01:00",
          "Description": "sample string 16",
          "Id": 17,
          "Name": "sample string 18"
        }
      ]
    },
    {
      "KeywordGroupID": 1,
      "ChannelId": 2,
      "StartTime": "2018-11-20T22:35:31.5466667+01:00",
      "EndTime": "2018-11-20T22:35:31.5466667+01:00",
      "Annotations": [
        {
          "CallId": 1,
          "ChannelId": 2,
          "CreatedBy": 3,
          "EndTime": "2018-11-20T22:35:31.5466667+01:00",
          "ExcludedByWorkflow": true,
          "JobInstanceId": 6,
          "KeywordGroupId": 7,
          "ModifiedBy": 8,
          "OccurenceType": 0,
          "Processed": true,
          "RecordingId": 10,
          "Source": 0,
          "SpeechJobId": 11,
          "StartTime": "2018-11-20T22:35:31.5466667+01:00",
          "Type": 0,
          "Value": 13.1,
          "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
          "DateModified": "2018-11-20T22:35:31.5466667+01:00",
          "Description": "sample string 16",
          "Id": 17,
          "Name": "sample string 18"
        },
        {
          "CallId": 1,
          "ChannelId": 2,
          "CreatedBy": 3,
          "EndTime": "2018-11-20T22:35:31.5466667+01:00",
          "ExcludedByWorkflow": true,
          "JobInstanceId": 6,
          "KeywordGroupId": 7,
          "ModifiedBy": 8,
          "OccurenceType": 0,
          "Processed": true,
          "RecordingId": 10,
          "Source": 0,
          "SpeechJobId": 11,
          "StartTime": "2018-11-20T22:35:31.5466667+01:00",
          "Type": 0,
          "Value": 13.1,
          "DateCreated": "2018-11-20T22:35:31.5466667+01:00",
          "DateModified": "2018-11-20T22:35:31.5466667+01:00",
          "Description": "sample string 16",
          "Id": 17,
          "Name": "sample string 18"
        }
      ]
    }
  ]
}