ChatDetail

One chat run and its conversation so far, as GET /v1/chats/{id} and the chat.ended webhook see it.

  • Your organization's address on the channel.

  • The channel the chat runs on.

    values
    smswebemail
  • the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • The person's address on the channel.

  • Where a chat run is in its life. After the conversation ends, a chat that started waits in post_processing while Resia writes its analysis; then it ends completed (the agent ended it) or cancelled (you cancelled it). failed means the chat never started.

    values
    pendingactivepost_processingcompletedfailedcancelled
  • The conversation so far, oldest first.

    Properties: 3
  • the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • The end-of-chat analysis, present once the chat has ended and Resia has written it. Null while the chat is open or post_processing, for a chat that never started, and when no analysis that fits the Chat Agent's analysis_schema could be written.

    Properties: 1
  • The database selected for this chat, or null when none was usable.

  • When the chat reached its final status: completed, failed, or cancelled. Null while it is open or post_processing.

  • Why the chat failed when its first text could not be delivered: the same reason the text-message reads report for that text, such as sender_not_registered when the sending number is not yet registered for business texting. Null for every other chat, including a chat that failed for another reason.

    Properties: 2
  • The stage this chat last reported, or null when it has reported none. One of the names its Chat Agent version declared in milestones.

  • When the conversation started: on sms, when the carrier confirmed delivery of the first text or the person first replied, whichever came first; for a chat the person started by texting your number, when that text arrived; on web, when the agent's first message was stored. Null while the chat is pending, and for a chat that ended before it started.

  • Open key/value labels on this record. Set any keys and any values. Filter a list by one key and value pair. Resia never interprets a tag. Do not put names, phone numbers, or any personal, health, credential, or secret information in a tag: a tag travels in URLs when used as a filter, and URLs appear in ordinary infrastructure request logs.

    Properties: 1
  • The tool requests and results the Chat Agent recorded, in recorded order. Present only on GET /v1/chats/{id} with include_tool_activity=true; null otherwise. The chat.ended webhook body leaves out both tool activity fields. Tool details never reach the person on the channel.

    Properties: 9
  • True when a size limit left events out or cut a payload preview, or when an unreadable record was left out. tool_activity then holds the earliest events only.