Skip to main content

Uniphore Customer Portal

2. Summary Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "id of the contact"
    },
    "startTime": {
      "type": "integer",
      "description": "timestamp in milliseconds since epoch"
    },
    "lang": {
      "type": "string"
    },
    "intent": {
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string"
        },
        "customerId": {
          "type": "string"
        },
        "contactType": {
          "type": "string"
        },
        "journeyId": {
          "type": "string"
        },
        "tenantId": {
          "type": "string"
        },
        "organizationId": {
          "type": "string"
        },
        "categoryId": {
          "type": "string"
        }
      },
      "required": [
        "agentId",
        "customerId",
        "contactType",
        "journeyId",
        "tenantId",
        "organizationId",
        "categoryId"
      ]
    },
    "isReviewed": {
      "type": "boolean",
      "description": "true if the summary has been reviewed by agent/supervisor"
    },
    "text": {
      "type": "string"
    },
    "manualEdits": {
      "type": "object",
      "properties": {
        "userId": {
          "type": "string"
        },
        "ts": {
          "type": "integer"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "userId",
        "ts",
        "text"
      ]
    }
  },
  "required": [
    "sessionId",
    "startTime",
    "lang",
    "intent",
    "metadata",
    "isReviewed",
    "text",
    "manualEdits"
  ]
}