ConversationsByWebsiteId: Crisp Conversations
read only REST
- Catálogo:
Crisp - Esquema:
Crisp - Llaves Primarias:
session_id - Label: Conversations
Solo puede recuperar datos.
Resumen
Lists conversations for website.
Fuente de la API
- Punto final:
/website/{website_id}/conversations/{page_number}?per_page=50
Parámetros
| Name | Tipo de Datos | 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. |
Columnas de la Tabla
A continuación se muestran las columnas de la tabla ConversationsByWebsiteId. Cada columna tiene un tipo de datos SQL. Se debe proporcionar un nuevo valor no nulo para cada columna requerida en todo momento durante la inserción y la actualización.
| Name | Tipo de Datos | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
active_ |
datetime |
itgen_crp_active_last | filtros en la plataforma, modificables, active. |
Timestamp at which the user was last active. | |
active_ |
char |
itgen_crp_active_now | filtros en la plataforma, modificables, active. |
Whether user is considered active right now or not. | |
assigned_ |
varchar2 |
itgen_crp_assigned_user_id | filtros en la plataforma, modificables, 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 | filtros en la plataforma, modificables, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_operator_excerpt | filtros en la plataforma, modificables, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_operator_timestamp | filtros en la plataforma, modificables, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_type | filtros en la plataforma, modificables, compose. |
Compose state type; one of start and stop. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_avatar | filtros en la plataforma, modificables, compose. |
Compose user avatar. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_nickname | filtros en la plataforma, modificables, compose. |
Compose user nickname. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_user_id | filtros en la plataforma, modificables, compose. |
Compose user identifier. | |
compose_ |
char |
itgen_crp_compose_visitor_automated | filtros en la plataforma, modificables, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_excerpt | filtros en la plataforma, modificables, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_visitor_timestamp | filtros en la plataforma, modificables, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_type | filtros en la plataforma, modificables, 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 | filtros en la plataforma, modificables, meta. |
Visitor address. | |
meta_ |
varchar2 |
itgen_crp_meta_avatar | filtros en la plataforma, modificables, meta. |
Visitor avatar. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_asn | filtros en la plataforma, modificables, meta. |
Autonomous system number, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_isp | filtros en la plataforma, modificables, meta. |
Name of the internet service provider, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_data | filtros en la plataforma, modificables, meta. |
Visitor data as JSON. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_city | filtros en la plataforma, modificables, meta. |
City name. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_latitude | filtros en la plataforma, modificables, meta. |
Latitude coordinate. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_longitude | filtros en la plataforma, modificables, meta. |
Longitude coordinate. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_country | filtros en la plataforma, modificables, meta. |
Country code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_region | filtros en la plataforma, modificables, meta. |
Region code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_major | filtros en la plataforma, modificables, meta. |
Browser major version (eg: version 8.1 has a major of 8). | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_name | filtros en la plataforma, modificables, meta. |
Browser name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_version | filtros en la plataforma, modificables, meta. |
Browser version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_name | filtros en la plataforma, modificables, meta. |
Engine name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_version | filtros en la plataforma, modificables, meta. |
Engine version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_name | filtros en la plataforma, modificables, meta. |
OS name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_version | filtros en la plataforma, modificables, meta. |
OS version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_useragent | filtros en la plataforma, modificables, meta. |
Visitor user agent. | |
meta_ |
int32 |
itgen_crp_meta_device_timezone | filtros en la plataforma, modificables, meta. |
Visitor device time zone offset in minutes relative to UTC, negated (-120 stands for UTC+02:00). | |
meta_ |
varchar2 |
itgen_crp_meta_email | filtros en la plataforma, modificables, meta. |
Visitor email. | |
meta_ |
varchar2 |
itgen_crp_meta_ip | filtros en la plataforma, modificables, meta. |
Visitor IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_nickname | filtros en la plataforma, modificables, meta. |
Visitor nickname. | |
meta_ |
varchar2 |
itgen_crp_meta_origin | filtros en la plataforma, modificables, meta. |
Conversation origin; chat, email or a URN of the channel used. | |
meta_ |
varchar2 |
itgen_crp_meta_phone | filtros en la plataforma, modificables, meta. |
Visitor phone. | |
meta_ |
varchar2 |
itgen_crp_meta_subject | filtros en la plataforma, modificables, 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 | filtros en la plataforma, modificables, preview_ |
Preview message excerpt. | |
preview_ |
int64 |
itgen_crp_preview_message_fingerprint | filtros en la plataforma, modificables, preview_ |
Preview message fingerprint. | |
preview_ |
varchar2 |
itgen_crp_preview_message_from | filtros en la plataforma, modificables, preview_ |
Preview message sender; one of user and operator. | |
preview_ |
varchar2 |
itgen_crp_preview_message_type | filtros en la plataforma, modificables, 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 | filtros en la plataforma, modificables, unread. |
Unread messages counter for operator. | |
unread_ |
int32 |
itgen_crp_unread_visitor | filtros en la plataforma, modificables, 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. |
Teclas
| Key | Column | Se refiere a | 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. |
Referenciado por
- 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)
Notas de la Versión
Cambios introducidos en cada versión en las tablas, columnas, atributos y capacidades del controlador: