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_ |
varchar2 |
Retrieve only the conversations assigned to this operator user identifier. | ||
filter_ |
datetime |
Retrieve only the conversations updated at or before this moment (UTC). | ||
filter_ |
datetime |
Retrieve only the conversations updated at or after this moment (UTC). | ||
filter_ |
varchar2 |
Retrieve only the conversations categorized under this inbox; use all for every inbox. | ||
filter_ |
boolean |
Retrieve only the conversations in which the user of the token is mentioned. | ||
filter_ |
boolean |
Retrieve only the conversations which are not resolved. | ||
filter_ |
boolean |
Retrieve only the conversations which are resolved. | ||
filter_ |
boolean |
Retrieve only the conversations which are not assigned to any operator. | ||
filter_ |
boolean |
Retrieve only the conversations with unread messages. | ||
include_ |
boolean |
Whether to include the conversations without any message. | ||
order_ |
boolean |
Whether to order the conversations by creation date instead of the default order. | ||
order_ |
boolean |
Whether to order the conversations by update date instead of the default order. | ||
order_ |
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_ |
varchar2 |
Search operator when the search type is filter; and or or, defaults to and. | ||
search_ |
varchar2 |
Search term over all conversations; a text when search_type is text or segment and a filter when it is filter. | ||
search_ |
varchar2 |
Search type; one of text, segment and filter. | ||
website_ |
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_ |
datetime |
itgen_crp_active_last | filters on the platform, writable, active. |
Timestamp at which the user was last active. | |
active_ |
char |
itgen_crp_active_now | filters on the platform, writable, active. |
Whether user is considered active right now or not. | |
assigned_ |
varchar2 |
itgen_crp_assigned_user_id | filters on the platform, writable, assigned. |
Operator user identifier. | |
availability |
varchar2 |
itgen_crp_availability | filters on the platform, writable | Visitor availability; one of online and offline. | |
compose_ |
char |
itgen_crp_compose_operator_automated | filters on the platform, writable, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_operator_excerpt | filters on the platform, writable, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_operator_timestamp | filters on the platform, writable, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_type | filters on the platform, writable, compose. |
Compose state type; one of start and stop. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_avatar | filters on the platform, writable, compose. |
Compose user avatar. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_nickname | filters on the platform, writable, compose. |
Compose user nickname. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_user_id | filters on the platform, writable, compose. |
Compose user identifier. | |
compose_ |
char |
itgen_crp_compose_visitor_automated | filters on the platform, writable, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_excerpt | filters on the platform, writable, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_visitor_timestamp | filters on the platform, writable, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_type | filters on the platform, writable, compose. |
Compose state type; one of start and stop. | |
created_ |
datetime |
itgen_crp_created_at | filters on the platform, writable | Conversation creation timestamp. | |
inbox_ |
varchar2 |
itgen_crp_inbox_id | filters on the platform, writable | Inbox identifier. | |
is_ |
char |
itgen_crp_is_blocked | filters on the platform, writable | Whether session is blocked or not (block messages from visitor). | |
is_ |
char |
itgen_crp_is_verified | filters on the platform, writable | Whether session is verified or not (user email ownership is authenticated). | |
last_ |
varchar2 |
itgen_crp_last_message | filters on the platform, writable | Last message excerpt (from visitor). | |
meta_ |
varchar2 |
itgen_crp_meta_address | filters on the platform, writable, meta. |
Visitor address. | |
meta_ |
varchar2 |
itgen_crp_meta_avatar | filters on the platform, writable, meta. |
Visitor avatar. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_asn | filters on the platform, writable, meta. |
Autonomous system number, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_isp | filters on the platform, writable, meta. |
Name of the internet service provider, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_data | filters on the platform, writable, meta. |
Visitor data as JSON. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_city | filters on the platform, writable, meta. |
City name. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_latitude | filters on the platform, writable, meta. |
Latitude coordinate. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_longitude | filters on the platform, writable, meta. |
Longitude coordinate. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_country | filters on the platform, writable, meta. |
Country code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_region | filters on the platform, writable, meta. |
Region code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_major | filters on the platform, writable, meta. |
Browser major version (eg: version 8.1 has a major of 8). | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_name | filters on the platform, writable, meta. |
Browser name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_version | filters on the platform, writable, meta. |
Browser version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_name | filters on the platform, writable, meta. |
Engine name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_version | filters on the platform, writable, meta. |
Engine version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_name | filters on the platform, writable, meta. |
OS name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_version | filters on the platform, writable, meta. |
OS version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_useragent | filters on the platform, writable, meta. |
Visitor user agent. | |
meta_ |
int32 |
itgen_crp_meta_device_timezone | filters on the platform, writable, meta. |
Visitor device time zone offset in minutes relative to UTC, negated (-120 stands for UTC+02:00). | |
meta_ |
varchar2 |
itgen_crp_meta_email | filters on the platform, writable, meta. |
Visitor email. | |
meta_ |
varchar2 |
itgen_crp_meta_ip | filters on the platform, writable, meta. |
Visitor IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_nickname | filters on the platform, writable, meta. |
Visitor nickname. | |
meta_ |
varchar2 |
itgen_crp_meta_origin | filters on the platform, writable, meta. |
Conversation origin; chat, email or a URN of the channel used. | |
meta_ |
varchar2 |
itgen_crp_meta_phone | filters on the platform, writable, meta. |
Visitor phone. | |
meta_ |
varchar2 |
itgen_crp_meta_subject | filters on the platform, writable, meta. |
Subject for conversation (if any). | |
people_ |
varchar2 |
itgen_crp_people_id | filters on the platform, writable | People identifier. | |
preview_ |
varchar2 |
itgen_crp_preview_message_excerpt | filters on the platform, writable, preview_ |
Preview message excerpt. | |
preview_ |
int64 |
itgen_crp_preview_message_fingerprint | filters on the platform, writable, preview_ |
Preview message fingerprint. | |
preview_ |
varchar2 |
itgen_crp_preview_message_from | filters on the platform, writable, preview_ |
Preview message sender; one of user and operator. | |
preview_ |
varchar2 |
itgen_crp_preview_message_type | filters on the platform, writable, preview_ |
Preview message type. | |
session_ |
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_ |
int32 |
itgen_crp_unread_operator | filters on the platform, writable, unread. |
Unread messages counter for operator. | |
unread_ |
int32 |
itgen_crp_unread_visitor | filters on the platform, writable, unread. |
Unread messages counter for visitor. | |
updated_ |
datetime |
itgen_crp_updated_at | filters on the platform, writable | Conversation update timestamp. | |
waiting_ |
datetime |
itgen_crp_waiting_since | filters on the platform, writable | Conversation waiting since timestamp (if any). | |
website_ |
varchar2 |
itgen_crp_website_id | filters on the platform, writable | Website identifier. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Conversations |
inbox_ |
InboxesByWebsiteId. |
Key | |
Conversations |
people_ |
PeopleProfilesByWebsiteId. |
Textual | The people profile of the visitor, as long as the profile exists; the conversation stays when the profile is deleted. |
Referenced By
- ConversationDeviceCapabilitiesByWebsiteId
session_id(Key) - ConversationDeviceLocalesByWebsiteId
session_id(Key) - ConversationMentionsByWebsiteId
session_id(Key) - ConversationMessageMentionsByWebsiteIdAndSessionId
session_id(Key) - ConversationMessagesByWebsiteIdAndSessionId
session_id(Key) - ConversationParticipantsByWebsiteId
session_id(Key) - ConversationRelatedChildrenByWebsiteIdAndSessionId
child_session_id(Key) - ConversationRelationsByWebsiteIdAndSessionId
parent_session_id(Key) - ConversationSegmentsByWebsiteId
session_id(Key) - ConversationVerificationsByWebsiteId
session_id(Key) - PeopleConversationsByWebsiteIdAndPeopleId
session_id(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: