Paths
Add telephone number to the blacklist
POST /blacklist
Get telephone numbers from the blacklist using OData filter
GET /blacklist
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< TelephoneBlacklistItem > array |
400 |
BadRequest |
No Content |
Get telephone number from the blacklist by the unique identifier
GET /blacklist({Id})
Update telephone number in the blacklist
PUT /blacklist({Id})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
Id |
key: Id |
integer (int32) |
Body |
TelephoneBlacklistItem |
The entity to put |
Delete telephone number from the blacklist
DELETE /blacklist({Id})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
If-Match |
If-Match header |
string |
Path |
Id |
key: Id |
integer (int32) |
Add a list of the telephone numbers to the blacklist. The number of added elements cannot be more than 10000.
POST /blacklist/Controller.Import
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
parameters |
OData parameters which contains list of the telephone numbers to be added to the blacklist |
parameters
| Name | Schema |
|---|---|
BlackListItems |
Get history of breaks using OData filter
GET /breakhistory
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< BreakHistory > array |
Get a specific break history entity by id
GET /breakhistory({Id})
Get history of calls using OData filter
GET /callhistory
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< CallHistory > array |
Get a specific call history entity by id
GET /callhistory({Id})
Get call history including replicated variables
GET /callhistorywithvariables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
When specified, only events that occurred before this time will be returned |
string (date-time) |
Query |
includeBreakTimes |
Whether break times are to be included |
boolean |
Query |
includeLoginLogoutInfo |
Whether login/logout information is to be included in the result |
boolean |
Query |
startTime |
When specified, only events occurring after this time will be returned |
string (date-time) |
Query |
surveyIds |
List of unique identifiers for the surveys (pXXXXXXXX), separated by comma or semicolon. If not specified, the history for all surveys will be returned. |
string |
Query |
variables |
Survey field names separated by comma or semicolon (having 'Available as CATI filter' option enabled) to be included in the result |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< CallHistoryWithVariables > array |
Create a new interviewer group
POST /groups
Get groups using OData filter
GET /groups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Group > array |
Get a specific group by an identifier
GET /groups({GroupId})
Update an existing interviewer group
PUT /groups({GroupId})
Delete an existing interviewer group
DELETE /groups({GroupId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
If-Match |
If-Match header |
string |
Path |
GroupId |
key: GroupId |
integer (int32) |
Assign the specified group to the specified call
GET /groups({GroupId})/Controller.AssignOnCall(surveyId='{surveyId}',interviewId={interviewId},callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Path |
interviewId |
Unique identifier of the interview |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Assign the specified group to the specified survey
GET /groups({GroupId})/Controller.AssignOnSurvey(surveyId='{surveyId}',callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Unassign the specified group from all calls on the specified survey
GET /groups({GroupId})/Controller.DeAssignFromCalls(surveyId='{surveyId}',callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Unassign the specified group from the specified survey
GET /groups({GroupId})/Controller.DeAssignFromSurvey(surveyId='{surveyId}',callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Get all assignment information related to the specified group
GET /groups({GroupId})/Controller.GetAssignments(callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< SurveyAssignment > array |
Get all interviewers belonging to the specified group
GET /groups({GroupId})/Controller.GetInterviewers(callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
GroupId |
key: GroupId |
integer (int32) |
Path |
callCenterId |
Unique identifier of the call center |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Interviewer > array |
Create a new interviewer
POST /interviewerproperties
Update an existing interviewer
PUT /interviewerproperties({InterviewerId})
Delete an existing interviewer
DELETE /interviewerproperties({InterviewerId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
If-Match |
If-Match header |
string |
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Get interviewers list using OData filter
GET /interviewers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Interviewer > array |
Get a specific interviewer by id
GET /interviewers({InterviewerId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Assign the specified interviewer to the specified call
GET /interviewers({InterviewerId})/Controller.AssignOnCall(surveyId='{surveyId}',interviewId={interviewId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Path |
interviewId |
Unique identifier of the interview |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Assign the specified interviewer to the specified survey
GET /interviewers({InterviewerId})/Controller.AssignOnSurvey(surveyId='{surveyId}')
Remove all assignments from the specified interviewer
GET /interviewers({InterviewerId})/Controller.CleanAssignments()
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Unassign the specified interviewer from all calls on the specified survey
GET /interviewers({InterviewerId})/Controller.DeAssignFromCalls(surveyId='{surveyId}')
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Path |
surveyId |
Unique identifier of the survey (pXXXXXXXX) |
string |
Unassign the specified interviewer from the specified survey
GET /interviewers({InterviewerId})/Controller.DeAssignFromSurvey(surveyId='{surveyId}')
Get all assignment information related to the specified interviewer
GET /interviewers({InterviewerId})/Controller.GetAssignments()
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< SurveyAssignment > array |
Get list of groups which contains the specified interviewer
GET /interviewers({InterviewerId})/Controller.GetGroups()
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Group > array |
Lock interviewer
GET /interviewers({InterviewerId})/Controller.Lock()
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Lock interviewer
GET /interviewers({InterviewerId})/Controller.Unlock()
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
InterviewerId |
key: InterviewerId |
integer (int32) |
Get history of interviewer sessions using OData filter
GET /interviewersessionhistory
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< InterviewerSessionHistory > array |
Get history of interviewer sessions using OData filter
GET /interviewersessionhistory({SessionId})
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< InterviewerSessionHistory > array |
Get surveys using OData filter
GET /surveys
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
$filter |
Filters the results, based on a Boolean condition. |
string |
Query |
$orderby |
Sorts the results. |
string |
Query |
$skip |
Skips the first n results. |
integer (int32) |
Query |
$top |
Returns only the first n results. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Survey > array |
Get all assignment information related to the specified survey
GET /surveys('{SurveyId}')/Controller.GetAssignments(callCenterId={callCenterId})
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
SurveyId |
key: SurveyId |
string |
Path |
callCenterId |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ResourceAssignment > array |
Get basic properties of the survey
GET /surveys('{SurveyId}')/Controller.GetBasicProperties()