ChatDetail

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

  • chat_agent_id
    Type: string
    min length:  
    1
    max length:  
    512
    required
  • chat_agent_version_id
    Type: string
    min length:  
    1
    max length:  
    512
    required
  • created_at
    Type: stringFormat: date-time
    required

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

  • from_phone_number
    Type: string
    required
  • id
    Type: string
    min length:  
    1
    max length:  
    512
    required
  • status
    Type: ChatStatusenum
    required

    Where a chat run is in its life.

    values
    pendingactivecompletedfailedcancelled
  • to_phone_number
    Type: string
    required
  • transcript
    Type: array of ChatTranscriptMessage
    required

    The conversation so far, oldest first.

    Properties: 3
  • updated_at
    Type: stringFormat: date-time
    required

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

  • analysis
    Type: ResiaJsonObjectnullable

    The end-of-chat analysis, present once the chat has completed and been analysed.

    Properties: 1
  • ended_at
    Type: stringFormat: date-timenullable

    When the chat reached a terminal status, or null while it is still open.