TranscriptMessage

One message in a customer's conversation transcript. Which fields are present depends on type.

  • action
    Type: string

    Event action, e.g. "assign" (on event messages).

  • agent_id
    Type: integer

    Agent identifier on an event message.

  • attachments
    Type: array | null

    Attachments on a dialog message, when present.

  • buttons
    Type: array string[]

    dialog button labels, parallel-indexed with payloads.

  • message

    The body. A string for text/button/dialog (for dialog, the title and button labels concatenated); an empty string for image; a number (the agent_id) for event.

    • Type: string

      The body. A string for text/button/dialog (for dialog, the title and button labels concatenated); an empty string for image; a number (the agent_id) for event.

  • message_datetime
    Type: string

    When the message was sent, formatted "YYYY-MM-DD HH:MM:SS" (not a Unix timestamp).

  • payload
    Type: string

    Routing payload on a button reply, e.g. "$0".

  • payloads
    Type: array string[]

    dialog button payloads, parallel-indexed with buttons.

  • rich_text
    Type: string | null

    HTML version of the body when present (text / dialog). May be null.

  • sender
    Type: string

    Display name of the sender — the customer's name (e.g. "Visitor #1234"), a bot persona, "Landbot" for system events, or an agent's name. There is no separate sender role/type field.

  • title
    Type: string

    Prompt text on a dialog message.

  • type
    Type: string

    Message type — e.g. text, button (a customer's button reply), dialog (a bot prompt with buttons), image (media), event (a system signal such as agent assignment), multi_question, structured_data. The set is open-ended; handle unknown types gracefully.

  • url
    Type: string

    Media URL on an image message.

  • urls
    Type: array (string | null)[]

    Per-button URL targets on a dialog (null where unset).