ConversationDeviceCapabilitiesByWebsiteId: Crisp Conversation Device Capabilities
read only REST
- Catalog:
Crisp - Schema:
Crisp - Label: Conversation Device Capabilities
Can only retrieve data.
Summary
Visitor device capabilities.
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 ConversationDeviceCapabilitiesByWebsiteId 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 |
|---|---|---|---|---|---|
capability |
varchar2 |
itgen_crp_capability | filters on the platform, writable, ::self |
Visitor device capability. | |
conversation_ |
datetime |
itgen_crp_conversation_active_last | filters on the platform, writable, ::ancestor. |
Timestamp at which the user was last active in the conversation. | |
conversation_ |
datetime |
itgen_crp_conversation_created_at | filters on the platform, writable, ::ancestor. |
Conversation creation timestamp. | |
conversation_ |
varchar2 |
itgen_crp_conversation_topic | filters on the platform, writable, ::ancestor. |
Topic for conversation (based on messages). | |
conversation_ |
datetime |
itgen_crp_conversation_updated_at | filters on the platform, writable, ::ancestor. |
Conversation update timestamp. | |
conversation_ |
datetime |
itgen_crp_conversation_waiting_since | filters on the platform, writable, ::ancestor. |
Conversation waiting since timestamp (if any). | |
session_ |
varchar2 |
itgen_crp_session_id | filters on the platform, writable, ::ancestor. |
Session identifier. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Conversation |
session_ |
ConversationsByWebsiteId. |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: