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

105 lines
4.3 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",
"usage",
"associated_objects"
],
"title": "SOSSession - Data API",
"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.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AppVersion": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The version of the customers mobile application in which SOS is implemented."
},
"CaseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the case thats associated with the SOS session."
},
"ContactId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the contact thats 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 customers 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 thats associated with the SOS video call."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the session records 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 organizations 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 customers mobile device from which the SOS call originated, such as the devices 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.\n\n- **SOSSessionFeed**: Feed tracking is available for the object.\n- **SOSSessionHistory**: History is available for tracked fields of the object.\n- **SOSSessionOwnerSharingRule**: Sharing rules are available for the object.\n- **SOSSessionShare**: Sharing is available for the object."
}