v1Sessions

Retrieve a session

Changed on

Accepts either the session id (Mongo ObjectId) or the call id (numeric). If the id is purely numeric, the session is looked up by call.id.

get/v1/sessions/{id}

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v1/sessions/{id}
  • Auth: none declared

Path parameters

idstring required

Response

idstring required

Id da sessão (ObjectId)

_idstring required
workspaceIdnumber required
interactionDatesstring[]
tagsnumber[]

Ids das tags da sessão

followersnumber[]

Ids dos operadores seguindo a conversa

scheduledMessagesnumber[]

Ids das mensagens agendadas

dealsobject nullable

Negócios (deals) vinculados

operatorMessagesCountnumber
assignedOperatorMessagesCountnumber
botMessagesCountnumber
contactMessagesCountnumber
totalMessagesCountnumber
messagesCountByDateobject

Contagem de mensagens por dia: { "2026-09-14": { bot, operator, contact } }

tmanumber nullable

Tempo médio de atendimento, em segundos

tmenumber nullable

Tempo médio de espera, em segundos

tmpnumber nullable

Tempo de primeira resposta, em segundos

tmpResetOnNewAssignmentboolean
summarystring nullable

Resumo da sessão gerado por IA

campaignIdstring nullable

Id da campanha que originou a sessão

mergedFromCustomerIdstring nullable
createdAtstring required
updatedAtstring required

Example response

{
  "id": "66e2f1c9a1b2c3d4e5f60718",
  "_id": "66e2f1c9a1b2c3d4e5f60718",
  "workspaceId": 1,
  "call": {
    "id": 987654,
    "customerPlatformId": 1234567,
    "workspacePlatformId": 103,
    "operatorId": 42,
    "groupId": 10,
    "protocol": "2026091412345",
    "customFields": {
      "origem": {
        "value": "site"
      }
    },
    "createdAt": "2026-09-14T11:58:00.000Z",
    "answeredAt": "2026-09-14T12:00:00.000Z",
    "finishedAt": "2026-09-14T12:30:00.000Z"
  },
  "contact": {
    "id": 555,
    "name": "João Silva",
    "email": "joao@gmail.com",
    "phone": "5585988887777",
    "createdAt": "2026-01-10T10:00:00.000Z",
    "customFields": {
      "cpf": {
        "value": "000.000.000-00"
      }
    }
  },
  "conversation": {
    "id": 1234567,
    "workspacePlatformId": 103,
    "identifier": "5585988887777"
  },
  "lastMessage": {
    "idMessage": 37826587,
    "content": "[{\"insert\":\"Olá\"}]",
    "createdAt": "2026-09-14T12:30:00.000Z"
  },
  "rating": {
    "value": 5
  },
  "trails": [
    {
      "date": "2026-09-14T12:00:00.000Z",
      "isodate": "2026-09-14T12:00:00.000Z",
      "type": "operator",
      "id": 42
    }
  ],
  "interactions": [
    {
      "date": "2026-09-14T12:00:00.000Z",
      "operatorId": 42
    }
  ],
  "interactionDates": [
    "2026-09-14"
  ],
  "tags": [
    3,
    8
  ],
  "operatorMessagesCount": 4,
  "assignedOperatorMessagesCount": 4,
  "botMessagesCount": 2,
  "contactMessagesCount": 5,
  "totalMessagesCount": 11,
  "messagesCountByDate": {
    "2026-09-14": {
      "bot": 2,
      "operator": 4,
      "contact": 5
    }
  },
  "tma": 1800,
  "tme": 120,
  "tmp": 90,
  "createdAt": "2026-09-14T11:58:00.000Z",
  "updatedAt": "2026-09-14T12:30:00.000Z"
}

Changes

  • b2a10af596dbRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status