--- schema_version: "1" id: ca8741ecc0eacfd338710400840724e9e7afa386d88b450fa8f94c524ffee96d title: SOSSession collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_sossession.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_sossession.htm source_site: developer.salesforce.com content_type: documentation content_hash: 1a66379aa49216746987ed8b6f7f1f16a44637faaa55f14ab486d7a589ef9fe7 description: This object is automatically created for each SOS session and stores information about the session. This object is available in API versions 34.0 and later. --- # SOSSession This object is automatically created for each SOS session and stores information about the session. This object is available in API versions 34.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field Name | Details | | --- | --- | | AppVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of the customer’s mobile application in which SOS is implemented. | | CaseId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the case that’s associated with the SOS session. | | ContactId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the contact that’s associated with the SOS session. | | DeploymentId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the SOS deployment that the SOS session originated from. | | EndTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session ended. | | IpAddress | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description To protect the customer’s privacy, this field is now blank. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last referenced by a user. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The date and time that the session record was last viewed. | | Name | Type string Properties Autonumber, Defaulted on create, Filter, Sort Description The name of the session. | | OpentokSession | Type encryptedstring Properties Create, Nillable, Update Description The ID of the OpenTok session that’s associated with the SOS video call. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the session record’s owner. | | SessionDuration | Type int Properties Filter, Group, Nillable, Sort Description The amount of time that the SOS session lasted. | | SessionRecordingUrl | Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The URL where the SOS session recording is stored. | | SosVersion | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The version of SOS that was used in your organization’s mobile application when this session occurred. | | StartTime | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The time that the SOS session began. | | SystemInfo | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Information about the customer’s mobile device from which the SOS call originated, such as the device’s operating system. | | WaitDuration | Type int Properties Filter, Group, Nillable, Sort Description The amount of time the customer waited before an agent accepted the SOS session and the call began. | ## Usage Use this object to query and manage SOS session records. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [SOSSessionFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [SOSSessionHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [SOSSessionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [SOSSessionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.