LiveChatTranscript

This object is automatically created for each Live Agent chat session and stores information about the session.

Introduced in API version 23.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 30.0
  • Description: The amount of time in seconds an incoming chat request remained unanswered by an agent before the chat was disconnected by the customer.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the account associated with the chat transcript.
  • Relationship name: Account
  • Relationship type: relationship
  • Refers to: Account
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The agent’s average response time (in seconds) to chat messages from the visitor.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visitor’s average response time (in seconds) to chat messages from the agent.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The contents of the chat.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The browser the visitor used for the chat.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The language of the visitor’s browser.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the case associated with the chat transcript.
  • Relationship name: Case
  • Relationship type: relationship
  • Refers to: Case
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 30.0
  • Description: The total duration of the chat in seconds.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort
  • Introduced: API version 25.0
  • Description: The session ID of the chat before it is persisted. ChatKey can be used with advanced integrations in the Salesforce console.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the contact associated with the chat transcript.
  • Relationship name: Contact
  • Relationship type: relationship
  • Refers to: Contact
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The time the chat ended.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The way the chat was ended: by the operator, the visitor, or the system.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The auto-populated visitor’s IP address. Do not edit. Create a custom field if you need an IP address field for your use case.
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Introduced: API version 45.0
  • Description: Whether the visitor is chatting with a chatbot (true) or not (false).
  • Default value: false
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the lead associated with the chat transcript.
  • Relationship name: Lead
  • Relationship type: relationship
  • Refers to: Lead
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the LiveChatButton the chat session originated from.
  • Relationship name: LiveChatButton
  • Relationship type: relationship
  • Refers to: LiveChatButton
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the LiveChatDeployment the chat session originated from.
  • Relationship name: LiveChatDeployment
  • Relationship type: relationship
  • Refers to: LiveChatDeployment
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The ID of the visitor associated with the chat transcript.
  • Relationship name: LiveChatVisitor
  • Relationship type: relationship
  • Refers to: LiveChatVisitor
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The auto-populated best-guess approximation of the visitor’s location. Do not edit.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 30.0
  • Description: The maximum time in seconds it took an agent to respond to a chat visitor’s message.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 30.0
  • Description: The maximum time in seconds it took a customer to respond to an agent’s message.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the transcript.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of messages sent by one or more agents during the chat.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visitor’s operating system platform.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The auto-populated URI where the chat request originated. Do not edit.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The time the visitor requested the chat.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visitor’s screen resolution.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The auto-populated record ID of the primary Skill associated with the LiveChatButton the chat session originated from. Do not edit. To associate multiple skills with a LiveChatTranscript, use LiveChatTranscriptSkill junction objects.
  • Relationship name: Skill
  • Relationship type: relationship
  • Refers to: Skill
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The time the chat started.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The final status of the chat: completed, missed, or blocked.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Introduced: API version 28.0
  • Description: The text body of the supervisor’s chat transcript.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visitor’s user agent string.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of messages sent by the visitor during the chat.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 37.0
  • Description: The network or service provider the chat visitor used for the chat.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 30.0
  • Description: The total amount of time in seconds a chat request was waiting to be accepted by an agent.

Use this object to query and manage live chat transcripts.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.