ConversationByWebsiteIdAndSessionId: Crisp Conversation Data
read only REST
- Catalogo:
Crisp - Schema:
Crisp - Chiavi primarie:
session_id - Label: Conversation Data
È possibile solo recuperare i dati.
Riepilogo
One conversation of a website, retrieved by session identifier.
Codice sorgente dell'API
- Punto finale:
/website/{website_id}/conversation/{session_id}
Parametri
| Name | Tipo di dati | Required | Default | Documentation |
|---|---|---|---|---|
session_ |
varchar2 |
The conversation session identifier. | ||
website_ |
varchar2 |
The website identifier.Defaults to the website ID of the connection when left out. |
Colonne della tabella
Di seguito sono riportate le colonne della tabella ConversationByWebsiteIdAndSessionId. Ogni colonna ha un tipo di dati SQL. Un nuovo valore non nullo deve essere fornito per ogni colonna richiesta in ogni momento durante l'inserimento e l'aggiornamento.
| Name | Tipo di dati | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
active_ |
datetime |
itgen_crp_active_last | filtri sulla piattaforma, modificabili, active. |
Timestamp at which the user was last active. | |
active_ |
char |
itgen_crp_active_now | filtri sulla piattaforma, modificabili, active. |
Whether user is considered active right now or not. | |
assigned_ |
varchar2 |
itgen_crp_assigned_user_id | filtri sulla piattaforma, modificabili, 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 | filtri sulla piattaforma, modificabili, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_operator_excerpt | filtri sulla piattaforma, modificabili, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_operator_timestamp | filtri sulla piattaforma, modificabili, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_type | filtri sulla piattaforma, modificabili, compose. |
Compose state type; one of start and stop. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_avatar | filtri sulla piattaforma, modificabili, compose. |
Compose user avatar. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_nickname | filtri sulla piattaforma, modificabili, compose. |
Compose user nickname. | |
compose_ |
varchar2 |
itgen_crp_compose_operator_user_user_id | filtri sulla piattaforma, modificabili, compose. |
Compose user identifier. | |
compose_ |
char |
itgen_crp_compose_visitor_automated | filtri sulla piattaforma, modificabili, compose. |
Whether compose is automated or not (ie. comes from a bot). | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_excerpt | filtri sulla piattaforma, modificabili, compose. |
Message excerpt for compose state. | |
compose_ |
datetime |
itgen_crp_compose_visitor_timestamp | filtri sulla piattaforma, modificabili, compose. |
Timestamp for compose state. | |
compose_ |
varchar2 |
itgen_crp_compose_visitor_type | filtri sulla piattaforma, modificabili, 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 | filtri sulla piattaforma, modificabili, meta. |
Visitor address. | |
meta_ |
varchar2 |
itgen_crp_meta_avatar | filtri sulla piattaforma, modificabili, meta. |
Visitor avatar. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_asn | filtri sulla piattaforma, modificabili, meta. |
Autonomous system number, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_connection_isp | filtri sulla piattaforma, modificabili, meta. |
Name of the internet service provider, derived by Crisp from the IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_data | filtri sulla piattaforma, modificabili, meta. |
Visitor data as JSON. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_city | filtri sulla piattaforma, modificabili, meta. |
City name. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_latitude | filtri sulla piattaforma, modificabili, meta. |
Latitude coordinate. | |
meta_ |
decimal |
itgen_crp_meta_device_geolocation_coordinates_longitude | filtri sulla piattaforma, modificabili, meta. |
Longitude coordinate. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_country | filtri sulla piattaforma, modificabili, meta. |
Country code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_geolocation_region | filtri sulla piattaforma, modificabili, meta. |
Region code. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_major | filtri sulla piattaforma, modificabili, meta. |
Browser major version (eg: version 8.1 has a major of 8). | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_name | filtri sulla piattaforma, modificabili, meta. |
Browser name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_browser_version | filtri sulla piattaforma, modificabili, meta. |
Browser version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_name | filtri sulla piattaforma, modificabili, meta. |
Engine name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_engine_version | filtri sulla piattaforma, modificabili, meta. |
Engine version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_name | filtri sulla piattaforma, modificabili, meta. |
OS name. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_os_version | filtri sulla piattaforma, modificabili, meta. |
OS version. | |
meta_ |
varchar2 |
itgen_crp_meta_device_system_useragent | filtri sulla piattaforma, modificabili, meta. |
Visitor user agent. | |
meta_ |
int32 |
itgen_crp_meta_device_timezone | filtri sulla piattaforma, modificabili, meta. |
Visitor device time zone offset in minutes relative to UTC, negated (-120 stands for UTC+02:00). | |
meta_ |
varchar2 |
itgen_crp_meta_email | filtri sulla piattaforma, modificabili, meta. |
Visitor email. | |
meta_ |
varchar2 |
itgen_crp_meta_ip | filtri sulla piattaforma, modificabili, meta. |
Visitor IP address. | |
meta_ |
varchar2 |
itgen_crp_meta_nickname | filtri sulla piattaforma, modificabili, meta. |
Visitor nickname. | |
meta_ |
varchar2 |
itgen_crp_meta_origin | filtri sulla piattaforma, modificabili, meta. |
Conversation origin; chat, email or a URN of the channel used. | |
meta_ |
varchar2 |
itgen_crp_meta_phone | filtri sulla piattaforma, modificabili, meta. |
Visitor phone. | |
meta_ |
varchar2 |
itgen_crp_meta_subject | filtri sulla piattaforma, modificabili, 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 | filtri sulla piattaforma, modificabili, preview_ |
Preview message excerpt. | |
preview_ |
int64 |
itgen_crp_preview_message_fingerprint | filtri sulla piattaforma, modificabili, preview_ |
Preview message fingerprint. | |
preview_ |
varchar2 |
itgen_crp_preview_message_from | filtri sulla piattaforma, modificabili, preview_ |
Preview message sender; one of user and operator. | |
preview_ |
varchar2 |
itgen_crp_preview_message_type | filtri sulla piattaforma, modificabili, 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 | filtri sulla piattaforma, modificabili, unread. |
Unread messages counter for operator. | |
unread_ |
int32 |
itgen_crp_unread_visitor | filtri sulla piattaforma, modificabili, 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. |
Note di rilascio
Cosa è cambiato, versione per versione, nelle tabelle, nelle colonne, negli attributi e nelle funzionalità del driver: