Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Блок кода
languagepy
themeDJango
titleОтвет в формате JSON
{
    "count": 1,
    "items": [
        {
            "id": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "taskName": "TWIN TEST",
            "taskId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "createdAt": "2024-01-01T00:00:18.722982Z",
            "startedAt": "2024-01-01T00:00:18.722136Z",
            "finishedAt": "2024-01-01T00:00:38.484110Z",
            "billedAt": "2024-01-01T00:00:57.902230Z",
            "updatedAt": "2024-01-01T00:00:57.908504Z",
            "speakerFinishedAt": "2024-01-01T00:00:38.484000Z",
            "number": "70000000000",
            "callingNumber": "70000000001",
            "botId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "botName": "TWIN BOT",
            "timezone": 10800,
            "messagesAsString": "BOT:  Добрый день, как ваши дела? \nCLIENT: Привет, дела - хорошо.",
            "resultsString": "{\"nps\": \"Успех\", \"confirmation\": \"Успех\"}",
            "variablesString": "{\"tryNumber\": 0, \"recordPath\": \"https://tcl.twin24.ai/record/db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd/download\", \"humanNumber\": 0, \"resultNumber\": 0, \"tryCandidate\": 0, \"answeredNumber\": 0, \"humanCandidate\": 0, \"resultCandidate\": 0, \"answeredCandidate\": 0}",
            "dialogResult": "Успех",
            "advStatus_ru": "Успешный",
            "nps": "Успех",
            "duration": 17,
            "externalId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd",
            "clientExternalId": null,
            "recordPath": "https://minio.twin24.ai/twin-cis-production/records/1672/2024/1/1/0000000000000000000000000_1_1.mp3",
            "currentStatusName": "ANSWERED",
            "mainCallDiscount": "0",
            "mainCallDuration": 17,
            "robotCallDuration": 17,
            "transferCallDuration": 0,
            "companyId": 1758,
            "companyName": "0001 | ТВИН: TEST",
            "price": "0.0",
            "resellerPrice": "0.000000",
            "resellerCompanyId": null,
            "resellerCompanyName": null,
            "mainCallCost": "0.00",
            "mainCallTotalCost": "0.0",
            "robotCallCost": "0.00",
            "robotCallTotalCost": "0.0",
            "transferCallCost": "0",
            "transferCallTotalCost": null,
            "isIncoming": false,
            "amd": "NOT_DEF",
            "autoCallCandidateId": "db5cb7fb-dc3e-4197-a7f5-93f63dc5bfbd"
        }
    ]
}

Описание полей ответа:

ПолеОписаниеТип поля
countОбщее количество записей.

Integer

itemsМассив записей.Array[Object]
| idИдентификатор звонка.String
| taskNameИмя задания на обзвон.String
| taskIdИдентификатор задания на обзвон.String
| createdAtДата и время создания задания на обзвон.String
| startedAtДата и время запуска задания на обзвон.String
| finishedAtДата и время окончания задания на обзвон.String
| billedAtДата и время расчета стоимости выполнения задания на обзвон.String
| updatedAtДата и время последнего обновления задания на обзвон.String
| speakerFinishedAtДата и время окончания разговора.String
| numberНомер с которого звонили клиенту.String
| callingNumberНомер на который звонили клиенту.String
| botIdИдентификатор сценария бота, использованного в задании на обзвон.String
| botNameИмя сценария бота.String
| timezoneСмещение временной зоны в секундах относительно UTC.Integer
| messagesAsStringТранскрибация диалога.String
| resultsStringСохраненные в блоке "Результат" данные: Подтверждение; NPS.String
| variablesStringСохраненные переменные.String
| dialogResultЗначение из блока "Результат" при выборе "Зафиксировать результативность": "Успех" или "null".String
| advStatus_ruЗначение из блока "Результат" при выборе "Зафиксировать результативность": "Успешно".String
| npsЗначение из блока "Результат" в NPS.String
| durationПродолжительность звонка в секундах.Integer
| externalIdВнутренний системный идентификатор.String
| clientExternalIdВнешний идентификатор клиента.Boolean
| recordPathВеб-адрес записи разговора.String
| currentStatusName

Текущий статус задания на обзвон.

Возможные значения:

  • CANCEL – Отменен
  • ANSWERED – Успешный;
  • NOANSWER – Нет ответа;
  • BUSY – Абонент занят;
  • CONGESTION – Вызов отклонен оператором связи;
  • CHANUNAVAIL – Нет связи с телефонной линией;
  • FAILED – Ошибка;
  • SCHEDULED – Запланирован;
  • BLACKLIST – В черном списке;
  • DIAL – Набор номера;
  • INPROGRESS – В процессе;
  • FZ230 – Запрет звонка по ФЗ-230;
  • INVALID – Ошибка формата номера;
  • UNAVAILABLE – Номер недоступен;
  • EXPIRED – Срок ожидания соединения истек.

String

| mainCallDiscountСкидка за разговор (транк клиента).String
| mainCallDurationДлительность разговора (транк клиента) в секундах.Integer
| robotCallDurationПродолжительность работы робота в секундах.Integer
| transferCallDurationДлительность звонка после перевода в секунадх.Integer
| companyIdИдентификатор компании.Integer
| companyNameИдентифиактор компании и имя компании.String
| priceСтоимость всего разговора.String
| resellerPriceСтоимость разговора для реселлера.String
| resellerCompanyIdИдентификатор компании реселлера.Boolean
| resellerCompanyNameИмя компании реселлера.Boolean
| mainCallCostОбщая стоимость звонка.String
| mainCallTotalCostОбщая стоимость звонка.String
| robotCallCostСтоимость распознавания роботом.String
| robotCallTotalCostСтоимость разговора робота со скидкой.String
| transferCallCostСтоимость разговора после перевода.String
| transferCallTotalCostСтоимость разговора после перевода со скидкой.Boolean
| isIncomingВходящий/Исходящий вызов (true/false).Boolean
| amdРежим работы определителя человека или робота.String
| autoCallCandidateIdИдентификатор кандидата.String

Поле

Тип

Обязательно

Описание

countintдаОбщее количество записей.
itemsArray[Object]даМассив записей.
|    idstringнетИдентификтор звонка.
|    taskNamestringнетИмя задания на обзвон.
|    taskIdstringнетИдентификатор задания на обзвон. 
|    createdAtstringнетДата и время создания задания на обзвон.
|    startedAtstringнетДата и время запуска задания на обзвон.
|   finishedAtstringнетДата и время окончания выполнения задания на обзвон.
| billedAt
stringнетДата и время расчёта стоимости выполнения задания на обзвон.
|   updatedAtstringнетДата и время последнего обновления задания на обзвон.
|   speakerFinishedAtstringнетДата и время окончания разговора. 
|   numberstringнетНомер с которого звонили клиенту. 
|   callingNumberstringнетНомер на который звонили клиенту.
|   dialogResultstringнетЗаписывается значение из блока "Результат" в котором выбрано "Зафиксировать результативность". Может принимать значения: "Успех"; "null".
|   advStatus_rustringнет
|   botIdstringнетID сценария бота, который использовался в задании на обзвон.
|   npsstringнет 
|   durationstringнет 
|   botNamestringнетИмя сценария бота.
|   timezon
stringнетCмещение временной зоны в секундах относительно координированного всемирного времени (UTC)
messagesAsString
stringнетТранскрибация диалога.
| resultsString
stringнетСодержит сохраненные в блоке "Результат": Подтверждение; NPS.
|  variablesStringstringнетСодержит сохраненные переменные.

   
|    taskStatusstringнет

Статус задания на обзвон. 

Возможные значения:

  • ERROR_PREPARING – Ошибка подготовки
  • PREPARING – Подготавливается к запуску
  • MAX_CPS – Превышен лимит CPS для аккаунта. Приостановлено
  • TIMEOUT – Таймаут обзвона. Аварийное завершение
  • PAUSED_NO_ROUTE – Приостановлено. Нет маршрутов для вызовов
  • READY – Готово к запуску
  • PAUSED_SCHEDULE – Приостановлено. По расписанию
  • HALTED – Остановлено навечно
  • PAUSED_NOBODY – Приостановлено. Некому звонить на данный момент
  • DELETING – В процессе удаления
  • PAUSED_NO_MONEY – Закончились деньги. Приостановлено
  • PAUSED – Приостановлено
  • PROCESS – В процессе обзвона
  • DONE – Обзвон завершен
  • BLANK – Пустое задание (обзвон невозможен)
|    callIdstringнетИдентификатор звонка.
|    startedAtstringнетДата и время начала звонка.
|    numberstringнетНомер телефона, на который был вызов.
|    callingNumberstringнетНомер телефона, с которого был вызов.
|    botIdstringнетИдентификатор бота.
|    botNamestringнетИмя бота.
|    regionNamestringнетРегион вызываемого абонента.
|    timezoneintнетТаймзона вызываемого абонента.
|    messagesAsStringstringнетСообщения диалога строкой.
|    messagesArray[Object]нетМассив сообщений.
|    |    authorTypestringнетТип автора сообщения (BOT, CLIENT).
|    |    createdAtstringнетДата создания сообщения.
|    |    bodystringнетТекс сообщения.
|    resultsStringstringнетЗначение из поля "Подтверждение результата".
|    allResultsObjectнет

Объект с результатами разговора.

Обязательно включает поля "nps" и "confirmation". 

Опционально (при наличии) включает поля со значением произвольных реультатов.

|    emotionstringнетОпределенная эмоция.
|    hungUpBystringнет

Кто "повесил трубку".

Возможные значения:

  • Робот
  • Человек
|    genderstringнетОпределенный гендер.
|    npsstringнетЗначение из поля "nps".
|    isAssistantRequeststringнетЗапросил ли бот помощь.
|    markersstringнетМаркеры.
|    durationintнетДлительность разговора.
|    externalIdstringнетВнутренний системный идентификатор. 
|    clientExternalIdstringнетВнешний идентификатор клиента, заданный при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр).
|    additionalstringнетДополнительные данные о диалоге.
|    recordPathstringнетСсылка на аудиозапись диалога.
|    currentStatusNamestringнет

Текущий статус диалога.

Возможные значения:

  • CANCEL – Отменен
  • ANSWERED – Успешный
  • NOANSWER – Нет ответа
  • BUSY – Абонент занят
  • CONGESTION – Вызов отклонен оператором связи
  • CHANUNAVAIL – Нет связи с телефонной линией
  • FAILED – Ошибка
  • SCHEDULED – Запланирован
  • BLACKLIST – В черном списке
  • DIAL – Набор номера
  • INPROGRESS – В процессе
  • FZ230 – Запрет звонка по ФЗ-230
  • INVALID – Ошибка формата номера
  • UNAVAILABLE – Номер недоступен
  • EXPIRED – Срок ожидания соединения истек
|    humanStatusNamestringнет

Текстовая расшифровка статуса диалога.

Возможные значения:

На русском:

  • Отменен
  • Успешный
  • Нет ответа
  • Абонент занят
  • Вызов отклонен оператором связи
  • Нет связи с телефонной линией
  • Ошибка
  • Запланирован
  • В черном списке
  • Набор номера
  • В процессе
  • Запрет звонка по ФЗ-230
  • Ошибка формата номера
  • Номер недоступен
  • Срок ожидания соединения истек

На английском:

  • Canceled
  • Answered
  • No answer
  • Busy
  • Congestion
  • Channel unavailable
  • Failed
  • Scheduled
  • Blacklisted
  • Dialing
  • In progress
  • Prohibited by FZ-230
  • Invalid number fromat
  • Unavailable
  • Connection expired
|    mainCallDiscountstringнетСкидка за разговор (транк клиента).
|    mainCallDurationintнетДлительность разговора (транк клиента).
|    autoCallCoststringнетВсегда равен 0.
|    autoCallDiscountstringнетВсегда равен 0.
|    autoCallDurationintнетВсегда равен 0.
|    autoCallTotalCoststringнетВсегда равен 0.
|    robotCallDiscountstringнетСкидка за разговор робота.
|    robotCallDurationintнетДлительность разговора робота.
|    transferCallDiscountstringнетСкидка за перевод звонка.
|    transferCallDurationintнетДлительность звонка после перевода.
|    companyIdintнетИдентификатор компании.
|    autoCallCandidateIdstringнетИдентификатор кандидата.
|    amdstringнет

Результат работы amd (система определения автоответчиков).

Возможные значения:

  • Человек
  • Автоответчик
  • Не проверялось
|    isCallEfficiencystringнет

Результативность вызова. 

Возможные значения:

  • Результативный
  • Нерезультативный
  • Не определено
|    totalCoststringнетСтоимость диалога.
|    mainCallCoststringнетСтоимость разговора (транк клиента).
|    mainCallTotalCoststringнетСтоимость разговора робота со скидкой.
|    robotCallCoststringнетСтоимость разговора робота.
|    robotCallTotalCoststringнетСтоимость разговора робота со скидкой.
|    transferCallCoststringнетСтоимость разговора после перевода.
|    transferCallTotalCoststringнетСтоимость разговора после перевода со скидкой.
|    variables-namestringнетvariables-var_name - поле, содержащее значение стартовой переменной с именем var_name, переданной при добавлении кандидата (как через апи метод, так и через интерфейс или excell реестр)

...