Paths

GET /

Responses

HTTP Code Description Schema

200

OK

RootResponse

401

Unauthorized

No Content

Produces

  • application/json

Tags

  • Root

Example HTTP response

Response 200

{
  "id" : "Confirmit.Public.Cati.Api",
  "links" : {
    "self" : "/",
    "callhistory" : "/callhistory",
    "spec" : "/swagger"
  }
}

Retrieves a list of call history objects.

GET /callhistory

Description

The response will be a list of CallHistory objects.

Sample request:

GET /callhistory

Parameters

Type Name Description Schema Default

Query

endTime
optional

Filters the records returned to those created before the specified end date.

string (date-time)

Query

page
optional

Determines which page of pageSize records to return. The default is 1. This parameter only applies when the Content-type is "application/json".

integer (int32)

1

Query

pageSize
optional

Controls the number of records returned in the response. The default is 100 and the maximum allowed value is 10000. This parameter only applies when the Content-type is "application/json".

integer (int32)

100

Query

startTime
optional

Filters the records returned to those created after the specified start date.

string (date-time)

Query

surveyId
optional

Filters the records returned to those associated with the specified SurveyId. You can filter by multiple SurveyIds by setting the parameter multiple times.

< string > array(multi)

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded.

ResourceCollection[CallHistory]

400

Bad request, the query parameters are not valid.

PublicApiError

401

Unauthorized

No Content

Produces

  • application/json

  • application/x-ndjson

Tags

  • CallHistory

Example HTTP response

Response 200

{
  "itemType" : "CallHistory",
  "itemCount" : 3,
  "totalCount" : 3,
  "items" : [ {
    "id" : 9,
    "time" : "2022-11-18T17:23:43+00:00",
    "surveyId" : "p916183813805",
    "interviewId" : 20,
    "interviewerId" : 15,
    "telephoneNumber" : "1234567890",
    "extendedStatus" : 13,
    "aaporCode" : "1.1",
    "duration" : 20,
    "waitingTime" : 5,
    "callCenterId" : 9,
    "endTime" : "0001-01-01T00:00:00+00:00",
    "links" : { }
  }, {
    "id" : 10,
    "time" : "2022-11-18T05:23:43+00:00",
    "surveyId" : "p916183813805",
    "interviewId" : 20,
    "interviewerId" : 16,
    "telephoneNumber" : "1234567891",
    "extendedStatus" : 13,
    "aaporCode" : "1.1",
    "duration" : 30,
    "waitingTime" : 5,
    "callCenterId" : 9,
    "endTime" : "0001-01-01T00:00:00+00:00",
    "links" : { }
  }, {
    "id" : 11,
    "time" : "2022-11-18T18:23:43+00:00",
    "surveyId" : "p916183813805",
    "interviewId" : 25,
    "interviewerId" : 19,
    "telephoneNumber" : "1234567892",
    "extendedStatus" : 13,
    "aaporCode" : "1.1",
    "duration" : 25,
    "waitingTime" : 5,
    "callCenterId" : 9,
    "endTime" : "0001-01-01T00:00:00+00:00",
    "links" : { }
  } ],
  "links" : { }
}
{
  "application/json" : {
    "itemType" : "CallHistory",
    "itemCount" : 3,
    "totalCount" : 3,
    "items" : [ {
      "id" : 9,
      "time" : "2022-11-18T17:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 20,
      "interviewerId" : 15,
      "telephoneNumber" : "1234567890",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 20,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    }, {
      "id" : 10,
      "time" : "2022-11-18T05:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 20,
      "interviewerId" : 16,
      "telephoneNumber" : "1234567891",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 30,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    }, {
      "id" : 11,
      "time" : "2022-11-18T18:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 25,
      "interviewerId" : 19,
      "telephoneNumber" : "1234567892",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 25,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    } ],
    "links" : { }
  },
  "application/x-ndjson" : {
    "itemType" : "CallHistory",
    "itemCount" : 3,
    "totalCount" : 3,
    "items" : [ {
      "id" : 9,
      "time" : "2022-11-18T17:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 20,
      "interviewerId" : 15,
      "telephoneNumber" : "1234567890",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 20,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    }, {
      "id" : 10,
      "time" : "2022-11-18T05:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 20,
      "interviewerId" : 16,
      "telephoneNumber" : "1234567891",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 30,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    }, {
      "id" : 11,
      "time" : "2022-11-18T18:23:43+00:00",
      "surveyId" : "p916183813805",
      "interviewId" : 25,
      "interviewerId" : 19,
      "telephoneNumber" : "1234567892",
      "extendedStatus" : 13,
      "aaporCode" : "1.1",
      "duration" : 25,
      "waitingTime" : 5,
      "callCenterId" : 9,
      "endTime" : "0001-01-01T00:00:00+00:00",
      "links" : { }
    } ],
    "links" : { }
  }
}

Response 400

{
  "message" : "The query parameters are not valid: ... ."
}
{
  "application/json" : {
    "message" : "The query parameters are not valid: ... ."
  },
  "application/x-ndjson" : {
    "message" : "The query parameters are not valid: ... ."
  }
}

Retrieves a list of dialer objects.

GET /dialers

Description

The response will be a list of Dialer objects.

Sample request:

GET /dialers

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded.

ResourceCollection[Dialer]

401

Unauthorized

No Content

Produces

  • application/json

Tags

  • Dialers

Example HTTP response

Response 200

{
  "itemType" : "Dialer",
  "itemCount" : 3,
  "totalCount" : 3,
  "items" : [ {
    "id" : 1,
    "name" : "Dialer1",
    "dialType" : "cellphone",
    "dialerStatus" : "connectedAndActivated",
    "links" : { }
  }, {
    "id" : 2,
    "name" : "Dialer2",
    "dialType" : "landline",
    "dialerStatus" : "disconnected",
    "links" : { }
  }, {
    "id" : 2,
    "name" : "Dialer3",
    "dialType" : "landline",
    "dialerStatus" : "connected",
    "links" : { }
  } ],
  "links" : { }
}

Retrieves a dialer object by id.

GET /dialers/{id}

Description

The response will be a Dialer object.

Sample request:

GET /dialers/{id}

Parameters

Type Name Description Schema

Path

id
required

The id of the dialer.

integer (int32)

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded.

Dialer

401

Unauthorized

No Content

404

Dialer with such id not found.

No Content

Produces

  • application/json

Tags

  • Dialers

Example HTTP response

Response 200

{
  "id" : 1,
  "name" : "Dialer1",
  "dialType" : "cellphone",
  "dialerStatus" : "connectedAndActivated",
  "links" : { }
}

Updates dialer status by dialer id.

PUT /dialers/{id}/status

Description

Sample request:

PUT /dialers/{id}/status?dialerStatus=disconnected

Parameters

Type Name Description Schema

Path

id
required

The id of the dialer.

integer (int32)

Query

dialerStatus
optional

New availability status of the dialer. Valid values are [Disconnected, Connected, ConnectedAndActivated]

string

Responses

HTTP Code Description Schema

204

NoContent, the request has succeeded.

No Content

400

Invalid dialer status

No Content

401

Unauthorized

No Content

500

Dialer availability is not changed

No Content

Tags

  • Dialers

Retrieves a list of Interviews.

GET /surveys/{surveyId}/interviews

Description

The response will be a list of Interviews.

Sample request:

GET /surveys/{surveyId}/interviews/

Parameters

Type Name Description Schema Default

Path

surveyId
required

The id of the survey (pXXXXXXXX).

string

Query

assignedResourceName
optional

Filters the records returned to those associated with the specified assignedResourceName.

string

Query

callState
optional

Filters the records returned to those associated with the specified callState. You can filter by multiple callStates by setting the parameter multiple times.

< CallState > array(multi)

Query

extendedStatusId
optional

Filters the records returned to those associated with the specified extendedStatusId. You can filter by multiple extendedStatusIds by setting the parameter multiple times.

< integer (int32) > array(multi)

Query

lastInterviewerName
optional

Filters the records returned to those associated with the specified lastInterviewerName.

string

Query

page
optional

Determines which page of pageSize records to return. The default is 1. This parameter only applies when the Content-type is "application/json".

integer (int32)

1

Query

pageSize
optional

Controls the number of records returned in the response. The default is 100 and the maximum allowed value is 10000. This parameter only applies when the Content-type is "application/json".

integer (int32)

100

Query

scheduled
optional

Set this parameter to "True" to get scheduled interviews only, or "False" to get not scheduled interviews only. Skip this parameter to get both scheduled and not scheduled interviews.

boolean

Responses

HTTP Code Description Schema

200

Ok, the request has succeeded.

ResourceCollection[Interview]

400

Bad request. The query parameters are not valid.

No Content

401

Unauthorized

No Content

403

Forbidden. You do not have access to this survey.

No Content

404

Survey with such id not found.

No Content

Produces

  • application/json

  • application/x-ndjson

Tags

  • Interviews

Example HTTP response

Response 200

{
  "itemType" : "Interview",
  "itemCount" : 1,
  "totalCount" : 1,
  "items" : [ {
    "surveyId" : "p999183813895",
    "interviewId" : 2,
    "telephoneNumber" : "0074852586932",
    "respondentName" : "1",
    "dialingMode" : "undefined",
    "dialTypeName" : "Landline",
    "dialTypeId" : 0,
    "lastInterviewerName" : "egork",
    "extendedStatusName" : "Completed",
    "extendedStatusId" : 13,
    "assignedResourceName" : "",
    "timezoneName" : "",
    "callAttemptsCount" : 0,
    "shiftType" : "",
    "reviewStatus" : "notSentToReview",
    "links" : { }
  } ],
  "links" : { }
}
{
  "application/json" : {
    "itemType" : "Interview",
    "itemCount" : 1,
    "totalCount" : 1,
    "items" : [ {
      "surveyId" : "p999183813895",
      "interviewId" : 2,
      "telephoneNumber" : "0074852586932",
      "respondentName" : "1",
      "dialingMode" : "undefined",
      "dialTypeName" : "Landline",
      "dialTypeId" : 0,
      "lastInterviewerName" : "egork",
      "extendedStatusName" : "Completed",
      "extendedStatusId" : 13,
      "assignedResourceName" : "",
      "timezoneName" : "",
      "callAttemptsCount" : 0,
      "shiftType" : "",
      "reviewStatus" : "notSentToReview",
      "links" : { }
    } ],
    "links" : { }
  },
  "application/x-ndjson" : {
    "itemType" : "Interview",
    "itemCount" : 1,
    "totalCount" : 1,
    "items" : [ {
      "surveyId" : "p999183813895",
      "interviewId" : 2,
      "telephoneNumber" : "0074852586932",
      "respondentName" : "1",
      "dialingMode" : "undefined",
      "dialTypeName" : "Landline",
      "dialTypeId" : 0,
      "lastInterviewerName" : "egork",
      "extendedStatusName" : "Completed",
      "extendedStatusId" : 13,
      "assignedResourceName" : "",
      "timezoneName" : "",
      "callAttemptsCount" : 0,
      "shiftType" : "",
      "reviewStatus" : "notSentToReview",
      "links" : { }
    } ],
    "links" : { }
  }
}