Definitions

BreakHistory

Class representing information about interviewer break

Name Description Schema

BreakTypeId
required

Unique identifier of a break type

integer (int32)

BreakTypeName
optional

Name of the break type

string

CallCenterId
required

Unique identifier of a call center

integer (int32)

Duration
optional

Duration of the break in seconds

integer (int32)

Id
required

Unique identifier of the break

integer (int32)

InterviewerId
required

Unique identifier of an interviewer

integer (int32)

IsPaid
optional

A flag indicating if the break is paid

boolean

SurveyId
optional

Unique identifier of a survey

string

Time
required

Time when the break was started

string (date-time)

CallHistory

Class representing information about the call attempt

Name Description Schema

CallCenterId
required

Unique identifier of the call center

integer (int32)

Duration
optional

Duration of the call attempt in seconds

integer (int32)

ExtendedStatus
optional

Extended status that has been assigned to the interview after the call attempt

integer (int32)

Id
required

Unique identifier of the call

integer (int32)

InterviewId
optional

Unique identifier of the interview

integer (int32)

InterviewerId
optional

Unique identifier of the interviewer

integer (int32)

SurveyId
optional

Unique identifier of the survey (pXXXXXXXX)

string

TelephoneNumber
optional

Telephone number

string

Time
required

Time of the call attempt

string (date-time)

WaitingTime
optional

Waiting time (in seconds) before the call has started

integer (int32)

CallHistoryWithVariables

Class representing information about the call attempt including survey fields

Name Description Schema

CallCenterId
optional

Unique identifier of the call center

integer (int32)

Duration
optional

Duration of the call attempt in seconds

integer (int32)

ExtendedStatus
optional

Extended status that has been assigned to the interview after the call attempt

integer (int32)

Id
optional

Unique identifier of the call

integer (int32)

InterviewId
optional

Unique identifier of the interview

integer (int32)

InterviewerId
optional

Unique identifier of the interviewer

integer (int32)

InterviewerName
optional

Interviewer name

string

NumberInOrder
required

Unique number of entity

integer (int32)

SurveyId
optional

Unique identifier of the survey (pXXXXXXXX)

string

SurveyName
optional

Survey name

string

TelephoneNumber
optional

Telephone number

string

Time
optional

Time of the call

string (date-time)

WaitingTime
optional

Waiting time (in seconds) before the call has started

integer (int32)

Group

Class representing information about the group of interviewers

Name Description Schema

Description
required

Description of the group

string

GroupId
optional

Unique identifier of the group Required for 'PUT' requests but should be omitted for 'POST' requests.

integer (int32)

Name
required

Name of the group

string

ParentGroups
optional

List of unique identifiers of parent group. Deprecated in the new design.

< integer (int32) > array

Interviewer

Class representing information about the interviewer

Name Description Schema

AllowedChoices
optional

Available task choices if [ManualSelection] is Choice mode (3). Can have one or several values from Automatic, Manual or SurveyAssignment.

enum (Automatic, Manual, SurveyAssignment)

AssignmentsListMode
required

Identifies which calls are to be commenced

enum (AssignedCallsOnly, AllCalls)

AutomaticSurveyId
optional

Unique identifier of the survey to be logged into automatically if [ManualSelection] is the survey assignment mode (2)

string

CallCenterId
required

Unique identifier of the call center

integer (int32)

CallGroupId
optional

Unique identifier of the call group. For an interviewer to be delivered calls automatically for a survey where Call Groups are enabled, the interviewer must be a member of a Call Group. If they are not a member of a Call Group, no calls will be delivered automatically. An interviewer can be a member of one Call Group only.This can be changed at any time, and any changes will take effect on the next call delivered. Interviewers who are working as a member of a call group must have the "Survey Selection" task choice, otherwise Call Groups cannot be used. When working as a member of a Call Group, calls are delivered based on the Extended Statuses in that Call Group.

integer (int32)

Description
optional

Description of the interviewer

string

DialTypeId
optional

Dial type of the interviewer: 0 - Automatic, 1 - Manual

integer (int32)

HasNewMessage
optional

Flag to show that there is a new message from supervisor for the interviewer

boolean

InterviewerId
required

Unique identifier of the interviewer

integer (int32)

IsLocked
required

Flag to mark the locked interviewer

boolean

Location
optional

The location field is an optional property that can be used to associate the interviewer with a localized dialer gateway. Please note that only valid location names (as specified in the dialer gateway configuration settings) should be entered here.

string

LockedDate
optional

Date and time when the user was locked

string (date-time)

ManualSelection
required

Task choice: 0 - Automatic, 1 - Manual, 2 - SurveyAssignment and 3 - Choice. If [AllowedChoices] is not null the system decides that this field has Choice mode (3) but in reality it can have any value in this case.

integer (int32)

Name
required

Name of the interviewer

string

PwdSetDate
required

Date of the last password change

string (date-time)

InterviewerProperties

Class representing extended information about the interviewer

Name Description Schema

AllowedTaskChoice
required

Available task choices if [Mode] is choice mode. Can have one or several values from Automatic, Manual or SurveyAssignment.

< enum (Automatic, Manual, SurveyAssignment) > array

AssignmentsListMode
optional

Identifies which calls are to be commenced

enum (AssignedCallsOnly, AllCalls)

AutomaticSurveyId
optional

Unique identifier of the survey to automatically login to if [Mode] is survey assignment

string

CallCenterId
optional

Unique identifier of the call center

integer (int32)

CallGroupId
optional

Unique identifier of the call group

integer (int32)

Description
required

Description of the interviewer

string

DialType
optional

Dial type of the interviewer

enum (Automatic, Manual)

InterviewerId
optional

Unique identifier of the interviewer. Required for 'PUT' requests but should be omitted for 'POST' requests.

integer (int32)

Location
optional

The location field is an optional property that can be used to associate the interviewer with a localized dialer gateway. Please note that only valid location names (as specified in the dialer gateway configuration settings) should be entered here.

string

Mode
optional

Task choice. This value is ignored if AllowedTaskChoice is specified.

enum (Automatic, Manual, SurveyAssignment, Choice)

Name
required

Name of the interviewer

string

ParentGroups
required

List of unique identifiers of the parent groups of the interviewer

< integer (int32) > array

Password
optional

Encrypted password of the interviewer

string

InterviewerSessionHistory

Class representing information about the history of the interviewer session

Name Description Schema

CallCenterId
required

Unique identifier of the call center

integer (int32)

CompanyId
required

Unique identifier of the company

integer (int32)

InterviewerId
required

Unique identifier of the interviewer

integer (int32)

LoginTime
required

Date and time of the login

string (date-time)

LogoutTime
optional

Date and time of the logout

string (date-time)

SessionId
required

Unique identifier of the session

integer (int32)

Link

A link to a node

Name Description Schema

href
optional

Relative url to node

string

method
optional

Defines the http method to use

string

rel
optional

Description of relation

string

ODataResponse[List[BreakHistory]]

Name Schema

@odata.context
optional

string

value
optional

< BreakHistory > array

ODataResponse[List[CallHistoryWithVariables]]

Name Schema

@odata.context
optional

string

value
optional

< CallHistoryWithVariables > array

ODataResponse[List[CallHistory]]

Name Schema

@odata.context
optional

string

value
optional

< CallHistory > array

ODataResponse[List[Group]]

Name Schema

@odata.context
optional

string

value
optional

< Group > array

ODataResponse[List[InterviewerSessionHistory]]

Name Schema

@odata.context
optional

string

value
optional

< InterviewerSessionHistory > array

ODataResponse[List[Interviewer]]

Name Schema

@odata.context
optional

string

value
optional

< Interviewer > array

ODataResponse[List[ResourceAssignment]]

Name Schema

@odata.context
optional

string

value
optional

< ResourceAssignment > array

ODataResponse[List[SurveyAssignment]]

Name Schema

@odata.context
optional

string

value
optional

< SurveyAssignment > array

ODataResponse[List[Survey]]

Name Schema

@odata.context
optional

string

value
optional

< Survey > array

ODataResponse[List[TelephoneBlacklistItem]]

Name Schema

@odata.context
optional

string

value
optional

< TelephoneBlacklistItem > array

ResourceAssignment

The class presents information about the assignment of interviewers and interviewer groups

Name Description Schema

AssignedCallsCount
required

The number of explicitly assigned calls

integer (int32)

IsGroup
required

Flag to show that this resource is a group

boolean

Name
required

Name of the interviewer or the interviewer group

string

ResourceId
required

Unique identifier of the interviewer or the interviewer group

integer (int32)

Survey

The class presents general information about the survey

Name Description Schema

SampleSize
required

Size of sample for the survey

integer (int32)

State
required

Current survey state

enum (Closed, Open, SoftDeleted)

SurveyId
required

Unique identifier of the survey (pXXXXXXXX)

string

SurveyName
required

Name of the survey

string

SurveyAssignment

The class presents information about assignments to a survey

Name Description Schema

AssignedCallsCount
required

Count of the calls assigned to the survey

integer (int32)

AssignmentType
required

Type of the assignment

enum (Implicit, Explicit, ImplicitToSurveyCalls)

SurveyId
required

Unique identifier of the survey (pXXXXXXXX)

string

SurveyBasicProperties

The class presents some basic properties of the survey

Name Description Schema

CallDeliveryMode
required

Call delivery mode of the survey

enum (InOrder, Random)

CallGroups
required

A flag indicating that survey uses call groups

boolean

ExtendedStatusGroup
required

Name of the extended status codes group assigned to the survey

string

Scheduling
required

Name of the scheduling script assigned to the survey

string

SurveyId
required

Unique identifier of the survey (pXXXXXXXX)

string

TelephoneBlacklistItem

Class representing information about the item in the blacklist

Name Description Schema

Id
optional

Unique identifier of the blacklist item. Required for 'PUT' requests but should be omitted for 'POST' requests.

integer (int32)

TelephoneNumber
required

Telephone number

string

Type
optional

Type of the telephone number

enum (Equal, StartWith)

TelephoneBlacklistItems

Class for importing list of the telephone numbers to the blacklist

Type : object

Variable

The class presents information about survey field

Name Description Schema

Name
optional

The name of the field

string

Value
optional

The value of the field

string