invantive documentation
Invantive Support ForumsLog In / Sign Up

ConversationsByWebsiteId: Crisp Conversations

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Primary Keys: session_id
  • Label: Conversations

Can only retrieve data.

Summary

Lists conversations for website.

API Source

  • Endpoint: /website/{website_id}/conversations/{page_number}?per_page=50

Parameters

Name Data Type Required Default Documentation
filter_assigned varchar2 Retrieve only the conversations assigned to this operator user identifier.
filter_date_end datetime Retrieve only the conversations updated at or before this moment (UTC).
filter_date_start datetime Retrieve only the conversations updated at or after this moment (UTC).
filter_inbox_id varchar2 Retrieve only the conversations categorized under this inbox; use all for every inbox.
filter_mention boolean Retrieve only the conversations in which the user of the token is mentioned.
filter_not_resolved boolean Retrieve only the conversations which are not resolved.
filter_resolved boolean Retrieve only the conversations which are resolved.
filter_unassigned boolean Retrieve only the conversations which are not assigned to any operator.
filter_unread boolean Retrieve only the conversations with unread messages.
include_empty boolean Whether to include the conversations without any message.
order_date_created boolean Whether to order the conversations by creation date instead of the default order.
order_date_updated boolean Whether to order the conversations by update date instead of the default order.
order_date_waiting boolean Whether to order the conversations by longest waiting date instead of the default order; this also leaves out the conversations which are not waiting.
search_operator varchar2 Search operator when the search type is filter; and or or, defaults to and.
search_query varchar2 Search term over all conversations; a text when search_type is text or segment and a filter when it is filter.
search_type varchar2 Search type; one of text, segment and filter.
website_id varchar2 The website identifier. Defaults to the website ID of the connection when left out.

Table Columns

The columns of the table ConversationsByWebsiteId 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
active_last datetime itgen_crp_active_last filters on the platform, writable, active.last Timestamp at which the user was last active.
active_now char itgen_crp_active_now filters on the platform, writable, active.now Whether user is considered active right now or not.
assigned_user_id varchar2 itgen_crp_assigned_user_id filters on the platform, writable, assigned.user_id Operator user identifier.
availability varchar2 itgen_crp_availability filters on the platform, writable Visitor availability; one of online and offline.
compose_operator_automated char itgen_crp_compose_operator_automated filters on the platform, writable, compose.operator.automated Whether compose is automated or not (ie. comes from a bot).
compose_operator_excerpt varchar2 itgen_crp_compose_operator_excerpt filters on the platform, writable, compose.operator.excerpt Message excerpt for compose state.
compose_operator_timestamp datetime itgen_crp_compose_operator_timestamp filters on the platform, writable, compose.operator.timestamp Timestamp for compose state.
compose_operator_type varchar2 itgen_crp_compose_operator_type filters on the platform, writable, compose.operator.type Compose state type; one of start and stop.
compose_operator_user_avatar varchar2 itgen_crp_compose_operator_user_avatar filters on the platform, writable, compose.operator.user.avatar Compose user avatar.
compose_operator_user_nickname varchar2 itgen_crp_compose_operator_user_nickname filters on the platform, writable, compose.operator.user.nickname Compose user nickname.
compose_operator_user_user_id varchar2 itgen_crp_compose_operator_user_user_id filters on the platform, writable, compose.operator.user.user_id Compose user identifier.
compose_visitor_automated char itgen_crp_compose_visitor_automated filters on the platform, writable, compose.visitor.automated Whether compose is automated or not (ie. comes from a bot).
compose_visitor_excerpt varchar2 itgen_crp_compose_visitor_excerpt filters on the platform, writable, compose.visitor.excerpt Message excerpt for compose state.
compose_visitor_timestamp datetime itgen_crp_compose_visitor_timestamp filters on the platform, writable, compose.visitor.timestamp Timestamp for compose state.
compose_visitor_type varchar2 itgen_crp_compose_visitor_type filters on the platform, writable, compose.visitor.type Compose state type; one of start and stop.
created_at datetime itgen_crp_created_at filters on the platform, writable Conversation creation timestamp.
inbox_id varchar2 itgen_crp_inbox_id filters on the platform, writable Inbox identifier.
is_blocked char itgen_crp_is_blocked filters on the platform, writable Whether session is blocked or not (block messages from visitor).
is_verified char itgen_crp_is_verified filters on the platform, writable Whether session is verified or not (user email ownership is authenticated).
last_message varchar2 itgen_crp_last_message filters on the platform, writable Last message excerpt (from visitor).
meta_address varchar2 itgen_crp_meta_address filters on the platform, writable, meta.address Visitor address.
meta_avatar varchar2 itgen_crp_meta_avatar filters on the platform, writable, meta.avatar Visitor avatar.
meta_connection_asn varchar2 itgen_crp_meta_connection_asn filters on the platform, writable, meta.connection.asn Autonomous system number, derived by Crisp from the IP address.
meta_connection_isp varchar2 itgen_crp_meta_connection_isp filters on the platform, writable, meta.connection.isp Name of the internet service provider, derived by Crisp from the IP address.
meta_data varchar2 itgen_crp_meta_data filters on the platform, writable, meta.data Visitor data as JSON.
meta_device_geolocation_city varchar2 itgen_crp_meta_device_geolocation_city filters on the platform, writable, meta.device.geolocation.city City name.
meta_device_geolocation_coordinates_latitude decimal itgen_crp_meta_device_geolocation_coordinates_latitude filters on the platform, writable, meta.device.geolocation.coordinates.latitude Latitude coordinate.
meta_device_geolocation_coordinates_longitude decimal itgen_crp_meta_device_geolocation_coordinates_longitude filters on the platform, writable, meta.device.geolocation.coordinates.longitude Longitude coordinate.
meta_device_geolocation_country varchar2 itgen_crp_meta_device_geolocation_country filters on the platform, writable, meta.device.geolocation.country Country code.
meta_device_geolocation_region varchar2 itgen_crp_meta_device_geolocation_region filters on the platform, writable, meta.device.geolocation.region Region code.
meta_device_system_browser_major varchar2 itgen_crp_meta_device_system_browser_major filters on the platform, writable, meta.device.system.browser.major Browser major version (eg: version 8.1 has a major of 8).
meta_device_system_browser_name varchar2 itgen_crp_meta_device_system_browser_name filters on the platform, writable, meta.device.system.browser.name Browser name.
meta_device_system_browser_version varchar2 itgen_crp_meta_device_system_browser_version filters on the platform, writable, meta.device.system.browser.version Browser version.
meta_device_system_engine_name varchar2 itgen_crp_meta_device_system_engine_name filters on the platform, writable, meta.device.system.engine.name Engine name.
meta_device_system_engine_version varchar2 itgen_crp_meta_device_system_engine_version filters on the platform, writable, meta.device.system.engine.version Engine version.
meta_device_system_os_name varchar2 itgen_crp_meta_device_system_os_name filters on the platform, writable, meta.device.system.os.name OS name.
meta_device_system_os_version varchar2 itgen_crp_meta_device_system_os_version filters on the platform, writable, meta.device.system.os.version OS version.
meta_device_system_useragent varchar2 itgen_crp_meta_device_system_useragent filters on the platform, writable, meta.device.system.useragent Visitor user agent.
meta_device_timezone int32 itgen_crp_meta_device_timezone filters on the platform, writable, meta.device.timezone Visitor device time zone offset in minutes relative to UTC, negated (-120 stands for UTC+02:00).
meta_email varchar2 itgen_crp_meta_email filters on the platform, writable, meta.email Visitor email.
meta_ip varchar2 itgen_crp_meta_ip filters on the platform, writable, meta.ip Visitor IP address.
meta_nickname varchar2 itgen_crp_meta_nickname filters on the platform, writable, meta.nickname Visitor nickname.
meta_origin varchar2 itgen_crp_meta_origin filters on the platform, writable, meta.origin Conversation origin; chat, email or a URN of the channel used.
meta_phone varchar2 itgen_crp_meta_phone filters on the platform, writable, meta.phone Visitor phone.
meta_subject varchar2 itgen_crp_meta_subject filters on the platform, writable, meta.subject Subject for conversation (if any).
people_id varchar2 itgen_crp_people_id filters on the platform, writable People identifier.
preview_message_excerpt varchar2 itgen_crp_preview_message_excerpt filters on the platform, writable, preview_message.excerpt Preview message excerpt.
preview_message_fingerprint int64 itgen_crp_preview_message_fingerprint filters on the platform, writable, preview_message.fingerprint Preview message fingerprint.
preview_message_from varchar2 itgen_crp_preview_message_from filters on the platform, writable, preview_message.from Preview message sender; one of user and operator.
preview_message_type varchar2 itgen_crp_preview_message_type filters on the platform, writable, preview_message.type Preview message type.
session_id varchar2 itgen_crp_session_id filters on the platform, writable Session identifier.
state varchar2 itgen_crp_state filters on the platform, writable Conversation state; one of pending, unresolved and resolved.
status int32 itgen_crp_status filters on the platform, writable Conversation status (a numeric alias of the state; useful for sorting conversations).
topic varchar2 itgen_crp_topic filters on the platform, writable Topic for conversation (based on messages).
unread_operator int32 itgen_crp_unread_operator filters on the platform, writable, unread.operator Unread messages counter for operator.
unread_visitor int32 itgen_crp_unread_visitor filters on the platform, writable, unread.visitor Unread messages counter for visitor.
updated_at datetime itgen_crp_updated_at filters on the platform, writable Conversation update timestamp.
waiting_since datetime itgen_crp_waiting_since filters on the platform, writable Conversation waiting since timestamp (if any).
website_id varchar2 itgen_crp_website_id filters on the platform, writable Website identifier.

Keys

Key Column Refers to Kind Description
ConversationsByWebsiteId_inbox_id_fk inbox_id InboxesByWebsiteId.inbox_id Key
ConversationsByWebsiteId_people_id_PeopleProfilesByWebsiteId_txt people_id PeopleProfilesByWebsiteId.people_id Textual The people profile of the visitor, as long as the profile exists; the conversation stays when the profile is deleted.

Referenced By

Release Notes

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