Get statistics on operator statuses in real time

Description: method allows getting data on the status of operators in real time (number of users in the statuses READY, NOT_READY, WORKING, TALKING, RESERVED, total number of logged-in operators)

Method: GET

URL: /api/v1/statistics/users/statuses.json

Description of fields: * - mandatory parameters

Field Value type Description

Possible answers:
Upon successful request, the server will respond with HTTP status 200, and data


    {
        "statuses": {
            "READY": 0,
            "NOT_READY": 1,
            "WORKING": 0,
            "TALKING": 0,
            "RESERVED": 0
        },
        "loggedUsers": 1
    }
  

Examples of unsuccessful response (errors):

 

 


Retrieve user statistics

Description: The method allows obtaining statistics on the CC user

Method: GET

URL: /api/v1/statistics/users/{userLogin}/statistics.json?fromDate={fromDate}&toDate={toDate}

Description of fields: * - required parameters

Field Value type Description
{userLogin}* string() User login
{fromDate}* string() Date since Format: "2017-10-25"
{toDate}* string() Date before. Format: "2017-10-25"

Possible answers:
Upon successful request, the server will respond with HTTP status 200, and data


    {
        "timeInSystem": 22276819,
        "timeTalk": 5687,
        "timeWorking": 2069,
        "timeReady": 3391,
        "timeNotReady": 22242666,
        "timeRing": 23006,
        "firstLoginDate": "2019-07-18T10:21:45",
        "lastLogoutDate": null,
        "timeIncome": 0,
        "countIncome": 0,
        "countAcdLost": 0,
        "timeOutgoing": 0,
        "countOutgoing": 0,
        "countIncomeInternal": 0,
        "timeIncomeInternal": 0,
        "countOutgoingInternal": 0,
        "notReadyStatus": {
            "Break": 44744,
            "Technical break": 0
        }
    }
  

Examples of unsuccessful response (errors):

 

 


Obtaining statistics on Web Recalls (Web Callbacks)

Description: The method allows you to obtain statistics on the Web Recall account, namely the number of created callbacks (NEW status), processed (STARTED), successfully called (SUCCESS), failed calls (FAILED), exhausted attempts to dial (EXPIRED)

Method: GET

URL: /api/v1/statistics/webrecalls/{recallId}.json

Description of fields: * - required parameters

Field Value type Description
{recallId}* integer() web recall account id. Learn {recallId}

Possible answers:
Upon successful request, the server will respond with HTTP status 200, and data


    {
    	"recallAccountId": 1,
    	"statusData": {
    		"NEW": 0,
    		"STARTED": 0,
    		"SUCCESS": 0,
    		"FAILED": 0,
    		"EXPIRED": 0
    	}
    }
  

Examples of unsuccessful response (errors):

 

 


Retrieve incoming call statistics

Description: The method allows receiving incoming call statistics for the specified period

Method: GET

URL: /api/v1/statistics/acd.json?fromDate={fromDate}&toDate={toDate}&offset={offsetN}&limit={limitN}

Description of fields: * - required parameters

Field Value type Description
{fromDate}* string() Date from. Format: "2017-10-25"
{toDate}* string() Date to. Format: "2017-10-25"
{offsetN}* integer() The value of the offset
{limitN}* integer() Data limit value. (minimum value 0, maximum 201)

Possible answers:
Upon successful request, the server will respond with an HTTP status 200, and an array of data


    [
    {
        "callDate": 1563458520000,
        "endCallDate": 1563458587000,
        "answerDate": 1563458533000,
        "incomeNumber": "799999999999",
        "acdName": "Входящие",
        "destinationNumber": "749510",
        "operatorNumber": "3010",
        "ivrStartDate": 1563458520000,
        "acdWaitTime": 12,
        "operatorName": "Spider Kirill",
        "talkingTime": 54,
        "workingTime": 40,
        "operatorRingTime": 6,
        "ivrBranchName": "Поднять трубку",
        "forwardNumber": null,
        "hungupSideStatus": "OPERATOR",
        "telemarketClientExternal": null,
        "ivrwaitTime": 0
    },
    {
        "callDate": 1563458483000,
        "endCallDate": null,
        "answerDate": null,
        "incomeNumber": "799999999999",
        "acdName": "Входящие",
        "destinationNumber": "749510",
        "operatorNumber": null,
        "ivrStartDate": 1563458483000,
        "acdWaitTime": 33,
        "operatorName": null,
        "talkingTime": 0,
        "workingTime": 0,
        "operatorRingTime": 0,
        "ivrBranchName": "Поднять трубку",
        "forwardNumber": null,
        "hungupSideStatus": null,
        "telemarketClientExternal": null,
        "ivrwaitTime": 0
    }
]

  

Examples of unsuccessful response (errors):

 

 


Getting telemarketing (TM) statistics

Description: the method allows you to get telemarketing (TM) statistics for the specified period with the specified client card data.

Method: GET

URL: /api/v1/statistics/telemarket.json?fromDate={fromDate}&toDate={toDate}&offset={offsetN}&limit={limitN}

Description of fields: * - required parameters

Field Value type Description
{fromDate}* string() Date from. Format: "2017-10-25"
{toDate}* string() Date to. Format: "2017-10-25"
{offsetN}* integer() Offset value
{limitN}* integer() Data Limit Values. (minimum value 0, maximum 201)

Possible answers:
Upon successful request, the server will respond with an HTTP status 200, and an array of data


    [
      {
          "id": 2381750,
          "updatedDate": 1563460916000,
          "campaignName": null,
          "clientName": null,
          "phoneNumber": "799999999999",
          "status": null,
          "operatorName": null,
          "clientСallStatus": null,
          "operatorCallStatus": null,
          "callTimeDuration": null,
          "clientCallTimeDuration": null,
          "recall": false,
          "parentId": 0,
          "ccprojectCallStatus": null,
          "hungupSideStatus": null,
          "closeFormCallStatus": null,
          "recallDescription": null,
          "recallType": null,
          "externalPhone": null,
          "calledCount": 4,
          "createdDate": 1563460916000,
          "ringingEndedAt": null,
          "client": {
              "offerName": "discounts-slim",
              "externalId": null,
              "offerId": 0001,
              "fio": "Test test",
              "mob": null,
              "string19": null,
              "string18": null,
              "companyName": null,
              "string15": null,
              "string14": null,
              "string17": null,
              "string16": null,
              "updatedDate": 1563099605000,
              "string11": null,
              "string10": null,
              "string13": null,
              "string12": null,
              "clientType": "SIMPLE",
              "tel": null,
              "fax": null,
              "timeZone": "Etc/GMT-10",
              "integer8": null,
              "integer9": null,
              "integer6": null,
              "integer7": null,
              "integer4": null,
              "integer5": null,
              "integer2": null,
              "integer3": null,
              "email": null,
              "date13": null,
              "parentId": 0,
              "createdDate": 1563099605000,
              "deleted": false,
              "date10": null,
              "dateTime1": null,
              "date12": null,
              "date11": null,
              "integer11": null,
              "integer12": null,
              "integer10": null,
              "externalIdStr": null,
              "personalOperatorId": null,
              "legalAddress": null,
              "presentation": "presentation",
              "string7": null,
              "string8": null,
              "string5": null,
              "string6": null,
              "string3": null,
              "string4": null,
              "string1": null,
              "string2": null,
              "string9": null,
              "decimal6": null,
              "decimal5": null,
              "decimal8": null,
              "decimal7": null,
              "decimal2": null,
              "decimal1": null,
              "decimal4": null,
              "decimal3": null,
              "integer15": null,
              "integer16": null,
              "integer13": null,
              "integer14": null,
              "decimal9": null,
              "integer17": null,
              "integer18": null,
              "decimal15": null,
              "decimal14": null,
              "decimal11": null,
              "decimal10": null,
              "decimal13": null,
              "decimal12": null,
              "secondaryTel": null,
              "comboString4": null,
              "comboString3": null,
              "statusInteger1": null,
              "comboString6": null,
              "statusInteger2": null,
              "string31": "14072019_109",
              "comboString5": null,
              "statusInteger3": null,
              "string30": null,
              "comboString2": null,
              "comboString1": null,
              "physicalAddress": null,
              "comboString8": null,
              "statusInteger4": null,
              "comboString7": null,
              "date9": null,
              "date8": null,
              "string29": null,
              "date7": null,
              "date6": null,
              "date5": null,
              "string26": null,
              "date4": null,
              "string25": null,
              "date3": null,
              "string28": null,
              "date2": null,
              "string27": null,
              "date1": null,
              "string22": null,
              "string21": null,
              "string24": null,
              "string23": null,
              "string20": null
          },
          "deleted": false
      }
  ]

  

Examples of unsuccessful response (errors):

 

 


Getting CDR statistics

Description: the method allows you to get CDR statistics for a specified period with the specified client card data.

Method: GET

URL: /api/v1/statistics/cdr.json?fromDate={fromDate}&toDate={toDate}&offset={offsetN}&limit={limitN}

Description of fields: * - required parameters

Field Value type Description
{fromDate}* string() Date from. Format: "2017-10-25"
{toDate}* string() Date to. Format: "2017-10-25"
{offsetN}* integer() Offset value
{limitN}* integer() Data Limit Values. (minimum value 0, maximum 201)

Possible answers:
Upon successful request, the server will respond with an HTTP status 200, and an array of data



    [
    {
        "id": 4464187,
        "callDate": 1563461424000,
        "aswerDate": 1563461424000,
        "fromPhoneNumber": "user1",
        "toPhoneNumber": "7999999999",
        "duration": 0,
        "status": "FAILED",
        "type": "Telemarket",
        "externalPhoneId": 21,
        "externalPhoneName": "ros_telecom",
        "callRoutingDirectionId": null,
        "callRoutingDirectionName": null,
        "groupId": 23,
        "groupName": "Обдзвон2",
        "hangupSideStatus": null
    },
    {
        "id": 4464186,
        "callDate": 1563461416000,
        "aswerDate": 1563461416000,
        "fromPhoneNumber": "user1",
        "toPhoneNumber": "7999999998",
        "duration": 0,
        "status": "FAILED",
        "type": "Telemarket",
        "externalPhoneId": 21,
        "externalPhoneName": "ros_telecom",
        "callRoutingDirectionId": null,
        "callRoutingDirectionName": null,
        "groupId": 23,
        "groupName": "Обдзвон2",
        "hangupSideStatus": null
    }
]


  

Examples of unsuccessful response (errors):