Skip to main content

CommunicationEpisodeSummaryRead

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

customer_idCustomer Idrequired
lead_idLead Idrequired

ID of the lead this record relates to.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

contact_idContact Idrequired

ID of the contact this record relates to.

channel_idChannel Idrequired

ID of the messaging channel this record relates to.

modalityModalityrequired

Possible values: [text, voice]

started_atdate-timerequired
ended_at object
anyOf
date-time
last_message_idLast Message Idrequired
content objectrequired
synopsisSynopsisrequired

Possible values: non-empty

customer_facts object[]
  • Array [
    • textTextrequired

    Possible values: non-empty

    source_message_idsinteger[]required

    Possible values: >= 1

  • ]
    • requests object[]
  • Array [
    • textTextrequired

    Possible values: non-empty

    source_message_idsinteger[]required

    Possible values: >= 1

  • ]
    • answered_questions object[]
  • Array [
    • textTextrequired

    Possible values: non-empty

    source_message_idsinteger[]required

    Possible values: >= 1

  • ]
    • unresolved_questions object[]
  • Array [
    • textTextrequired

    Possible values: non-empty

    source_message_idsinteger[]required

    Possible values: >= 1

  • ]
    • commitments object[]
  • Array [
    • partyPartyrequired

    Possible values: [customer, company]

    textTextrequired

    Possible values: non-empty

    statusStatusrequired

    Possible values: [open, completed, cancelled]

    due_at object
    anyOf
    date-time
    source_message_idsinteger[]required

    Possible values: >= 1

  • ]
    • outcome object
    anyOf
    textTextrequired

    Possible values: non-empty

    source_message_idsinteger[]required

    Possible values: >= 1

    recommended_next_action object
    anyOf
    string
    generator_versionGenerator Versionrequired
    generated_atdate-timerequired
    CommunicationEpisodeSummaryRead
    {
      "dialogue_id": 0,
      "customer_id": 0,
      "lead_id": 0,
      "product_id": 0,
      "agent_id": 0,
      "contact_id": 0,
      "channel_id": 0,
      "modality": "text",
      "started_at": "2024-07-29T15:51:28.071Z",
      "ended_at": "2024-07-29T15:51:28.071Z",
      "last_message_id": 0,
      "content": {
        "synopsis": "string",
        "customer_facts": [
          {
            "text": "string",
            "source_message_ids": [
              0
            ]
          }
        ],
        "requests": [
          {
            "text": "string",
            "source_message_ids": [
              0
            ]
          }
        ],
        "answered_questions": [
          {
            "text": "string",
            "source_message_ids": [
              0
            ]
          }
        ],
        "unresolved_questions": [
          {
            "text": "string",
            "source_message_ids": [
              0
            ]
          }
        ],
        "commitments": [
          {
            "party": "customer",
            "text": "string",
            "status": "open",
            "due_at": "2024-07-29T15:51:28.071Z",
            "source_message_ids": [
              0
            ]
          }
        ],
        "outcome": {
          "text": "string",
          "source_message_ids": [
            0
          ]
        },
        "recommended_next_action": "string"
      },
      "generator_version": "string",
      "generated_at": "2024-07-29T15:51:28.071Z"
    }