invantive documentation
Invantive Support ForumsLog In / Sign Up

ConversationParticipantsByWebsiteId: Crisp Conversation Participants

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Label: Conversation Participants

Can only retrieve data.

Summary

External participants for this conversation.

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 ConversationParticipantsByWebsiteId 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
conversation_active_last datetime itgen_crp_conversation_active_last filters on the platform, writable, ::ancestor.active.last Timestamp at which the user was last active in the conversation.
conversation_created_at datetime itgen_crp_conversation_created_at filters on the platform, writable, ::ancestor.created_at Conversation creation timestamp.
conversation_topic varchar2 itgen_crp_conversation_topic filters on the platform, writable, ::ancestor.topic Topic for conversation (based on messages).
conversation_updated_at datetime itgen_crp_conversation_updated_at filters on the platform, writable, ::ancestor.updated_at Conversation update timestamp.
conversation_waiting_since datetime itgen_crp_conversation_waiting_since filters on the platform, writable, ::ancestor.waiting_since Conversation waiting since timestamp (if any).
session_id varchar2 itgen_crp_session_id filters on the platform, writable, ::ancestor.session_id Session identifier.
target varchar2 itgen_crp_target filters on the platform, writable External participant target (ie. email address, identifier, etc.).
type varchar2 itgen_crp_type filters on the platform, writable External participant type.

Keys

Key Column Refers to Kind Description
ConversationParticipantsByWebsiteId_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: