afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ConversationContextEntry.json

99 lines
3.1 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "ConversationContextEntry - Data API",
"description": "Represents the context of a message or an event in the chat history between an agent and a messaging user. This object is available in API version 47.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ConversationContextEntryName": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The autogenerated number of the entry."
},
"CustomDetailContextKey": {
"type": "textarea",
"properties": "Create, Nillable",
"description": "The key or name of the pre-chat field specified by the admin in the pre-chat implementation, for example, customer_email."
},
"CustomDetailContextValue": {
"type": "textarea",
"properties": "Create, Nillable",
"description": "The value entered in the pre-chat field by a user before starting the chat."
},
"ParentId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The Conversation ID this entry is associated with."
}
},
"special_access_rules": "As of Summer 20 and later, only authenticated internal and external users can access this object.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **ConversationContextChangeEvent (API version 62.0)**: Change events are available for the object.",
"field_reference": {
"ConversationContextEntryName": {
"field_label": "Conversation Context Entry Name",
"type": "string",
"length": "255"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CustomDetailContextKey": {
"field_label": "Key",
"type": "textarea",
"length": "131072"
},
"CustomDetailContextValue": {
"field_label": "Value",
"type": "textarea",
"length": "131072"
},
"Id": {
"field_label": "Conversation Context Entry ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"ParentId": {
"field_label": "Chat Transcript ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}