conversationtranscript EntityType

Contains the transcripts of conversations between participants such as customers, Virtual Agents or Human agents.

Entity Set Path
[organization URI]/api/data/v9.2/conversationtranscripts
Base Type
Display Name
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
content Edm.String

Content of the conversation

Display Name: Content

conversationstarttime Edm.DateTimeOffset

The actual start time of the conversation (not the time it was written to the data store)

Display Name: ConversationStartTime

conversationtranscriptid Edm.Guid

Unique identifier for entity instances

Display Name: conversationtranscript

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

metadata Edm.String

Any metadata about the conversation being captured such as the schema version, state, agents, participants, etc if applicable.

Display Name: Metadata

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

schematype Edm.String

This defines the type of schema used for the conversation based on format used by the application writing this conversation (PVA, Omni-Channel, OBI, etc)

Display Name: SchemaType

schemaversion Edm.String

The version of the conversation transcript content schema that is used.

Display Name: ContentSchemaVersion

statecode Edm.Int32

Status of the conversationtranscript

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the conversationtranscript

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_bot_conversationtranscriptid_value bot_conversationtranscriptId

Conversation Transcripts related to customer interactions with a Bot

_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
bot_conversationtranscriptId bot bot_conversationtranscript
createdby systemuser lk_conversationtranscript_createdby
createdonbehalfby systemuser lk_conversationtranscript_createdonbehalfby
modifiedby systemuser lk_conversationtranscript_modifiedby
modifiedonbehalfby systemuser lk_conversationtranscript_modifiedonbehalfby
ownerid principal owner_conversationtranscript
owningbusinessunit businessunit business_unit_conversationtranscript
owningteam team team_conversationtranscript
owninguser systemuser user_conversationtranscript

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
conversationtranscript_AsyncOperations asyncoperation regardingobjectid_conversationtranscript
conversationtranscript_BulkDeleteFailures bulkdeletefailure regardingobjectid_conversationtranscript
conversationtranscript_DuplicateBaseRecord duplicaterecord baserecordid_conversationtranscript
conversationtranscript_DuplicateMatchingRecord duplicaterecord duplicaterecordid_conversationtranscript
conversationtranscript_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_conversationtranscript
conversationtranscript_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_conversationtranscript
conversationtranscript_ProcessSession processsession regardingobjectid_conversationtranscript
conversationtranscript_SyncErrors syncerror regardingobjectid_conversationtranscript


The following operations can be used with the conversationtranscript entity type.

Name Binding
CreateMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also