invantive documentation
Invantive Support ForumsLog In / Sign Up

ConversationMessagesByWebsiteIdAndSessionId: Crisp Conversation Messages

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Primary Keys: fingerprint
  • Label: Conversation Messages

Can only retrieve data.

Summary

All messages of one chat or email conversation, oldest batch last. Crisp returns the most recent batch first and the driver walks back in time using the timestamp of the oldest message retrieved.

API Source

  • Endpoint: /website/{website_id}/conversation/{session_id}/messages

Parameters

Name Data Type Required Default Documentation
session_id varchar2 The conversation session identifier.
website_id varchar2 The website identifier. Defaults to the website ID of the connection when left out.

Table Columns

The columns of the table ConversationMessagesByWebsiteIdAndSessionId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
automated char itgen_crp_automated filters on the platform, writable Whether the message is automated or not (ie. comes from a bot).
content varchar2 itgen_crp_content filters on the platform, writable Message content; the text itself for the types text and note, otherwise the content object as JSON.
content_duration int32 itgen_crp_content_duration filters on the platform, writable, content.duration Object duration in seconds (only set for the type audio).
content_explain varchar2 itgen_crp_content_explain filters on the platform, writable, content.explain Object explanatory text (only set for the type field).
content_id varchar2 itgen_crp_content_id filters on the platform, writable, content.id Object identifier (only set for the types picker and field).
content_name varchar2 itgen_crp_content_name filters on the platform, writable, content.name Object name (only set for the type file).
content_namespace varchar2 itgen_crp_content_namespace filters on the platform, writable, content.namespace Event namespace (only set for the type event).
content_required char itgen_crp_content_required filters on the platform, writable, content.required Whether the message must be filled before continuing (only set for the types picker and field).
content_text varchar2 itgen_crp_content_text filters on the platform, writable, content.text Object text (only set for the types picker, field, carousel and event).
content_type varchar2 itgen_crp_content_type filters on the platform, writable, content.type Object MIME type (only set for the types file, animation and audio).
content_url varchar2 itgen_crp_content_url filters on the platform, writable, content.url Object URL (only set for the types file, animation and audio).
content_value varchar2 itgen_crp_content_value filters on the platform, writable, content.value Object value (only set for the type field).
delivered varchar2 itgen_crp_delivered filters on the platform, writable Channel in which the message has last been delivered (can be blank).
edited char itgen_crp_edited filters on the platform, writable Whether the message was edited after being sent or not.
fingerprint int64 itgen_crp_fingerprint filters on the platform, writable Unique message fingerprint.
from varchar2 itgen_crp_from filters on the platform, writable Message sender; one of user and operator.
origin varchar2 itgen_crp_origin filters on the platform, writable Message origin; chat, email or a URN of the channel used.
original_id varchar2 itgen_crp_original_id filters on the platform, writable, original.original_id Identifier of the original message as held by the channel it arrived on (if any).
properties varchar2 itgen_crp_properties filters on the platform, writable Arbitrary properties set on the message as JSON (if any).
read varchar2 itgen_crp_read filters on the platform, writable Channel in which the message has been read (can be blank).
session_id varchar2 itgen_crp_session_id filters on the platform, writable Session identifier.
stamped char itgen_crp_stamped filters on the platform, writable Whether the message was fully processed in the internal Crisp pipeline.
timestamp datetime itgen_crp_timestamp filters on the platform, writable Timestamp at which the message was sent.
translated char itgen_crp_translated filters on the platform, writable Whether the message was automatically translated or not.
type varchar2 itgen_crp_type filters on the platform, writable Message type; one of text, note, file, animation, audio, picker, field, carousel and event.
user_avatar varchar2 itgen_crp_user_avatar filters on the platform, writable, user.avatar Sending user avatar.
user_nickname varchar2 itgen_crp_user_nickname filters on the platform, writable, user.nickname Sending user nickname.
user_type varchar2 itgen_crp_user_type filters on the platform, writable, user.type Sending user type; one of website and participant.
user_user_id varchar2 itgen_crp_user_user_id filters on the platform, writable, user.user_id Sending user identifier; an operator user identifier or a session identifier.
website_id varchar2 itgen_crp_website_id filters on the platform, writable Website identifier.

Keys

Key Column Refers to Kind Description
ConversationMessagesByWebsiteIdAndSessionId_session_id_fk session_id ConversationsByWebsiteId.session_id Key

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: