Получение статистики по статусам оператора в реальном времени

Описание: метод позволяет получить данные по статусам операторов в реальном времени (кол-во пользователей в статусах READY, NOT_READY, WORKING, TALKING, RESERVED, общее кол-во залогиненных операторов)

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и данными


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

Примеры неуспешного ответа (ошибок):

 

 


Получение статистики по пользователю

Описание: метод позволяет получить статистические данные по пользователю КЦ

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание
{userLogin}* string() Логин пользователя
{fromDate}* string() Дата с. Формат: "2017-10-25"
{toDate}* string() Дата до. Формат: "2017-10-25"

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и данными


    {
        "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": {
            "Обед": 44744,
            "Технический перерыв": 0
        }
    }
  

Примеры неуспешного ответа (ошибок):

 

 


Получение статистики по веб реколам

Описание: метод позволяет получить статистику по аккаунту веб рекола, а именно кол-во созданных реколов (статус NEW), обработанных (STARTED), успешно прозвоненных (SUCCESS), неуспешных дозвонов (FAILED), исчерпанных попыток дозвона (EXPIRED)

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание
{recallId}* integer() id аккаунта веб рекола. Как узнать значение {recallId}

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и данными


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

Примеры неуспешного ответа (ошибок):

 

 


Получение входящей статистики

Описание: метод позволяет получить входящую статистику за указанный период

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание
{fromDate}* string() Дата с. Формат: "2017-10-25"
{toDate}* string() Дата до. Формат: "2017-10-25"
{offsetN}* integer() Значение смещения
{limitN}* integer() Значения лимита данных. (минимальное значение 0, максимальное 201)

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и массивом данных


    [
    {
        "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
    }
]

  

Примеры неуспешного ответа (ошибок):

 

 


Получение ТМ статистики

Описание: метод позволяет получить ТМ статистику за указанный период с указанными данными карточки клиента.

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание
{fromDate}* string() Дата с. Формат: "2017-10-25"
{toDate}* string() Дата до. Формат: "2017-10-25"
{offsetN}* integer() Значение смещения
{limitN}* integer() Значения лимита данных. (минимальное значение 0, максимальное 201)

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и массивом данных


    [
      {
          "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": "Тест Тест",
              "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": "Презентация",
              "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
      }
  ]

  

Примеры неуспешного ответа (ошибок):

 

 


Получение CDR статистики

Описание: метод позволяет получить CDR статистику за указанный период с указанными данными карточки клиента.

Method: GET

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

Описание полей: * - обязательные параметры

Поле тип значения описание
{fromDate}* string() Дата с. Формат: "2017-10-25"
{toDate}* string() Дата до. Формат: "2017-10-25"
{offsetN}* integer() Значение смещения
{limitN}* integer() Значения лимита данных. (минимальное значение 0, максимальное 201)

Возможные ответы:
При успешном запросе, сервер ответит HTTP статусом 200, и массивом данных



    [
    {
        "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
    }
]


  

Примеры неуспешного ответа (ошибок):