Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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: Feed tracking is available for the object.
SOSSessionHistory: History is available for tracked fields of the object.
SOSSessionOwnerSharingRule: Sharing rules are available for the object.
SOSSessionShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

SOSSession

Supported Calls

Fields

Usage

Associated Objects