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

149 lines
5.0 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",
"associated_objects",
"field_reference"
],
"title": "VideoCallParticipant - Data API",
"description": "Represents a participant in a video call. Participant information can come from the video call provider (for example, Zoom), or Salesforce. This object is available in API version 51.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"Email": {
"type": "string",
"properties": "Filter, Group, idLookup, Nillable, Sort",
"description": "The email address of the participant, from the video call provider."
},
"IsAllowed": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the participant is admitted into the video call (true) or not (false). The default value is false."
},
"JoinDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the participant joins the video call."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it."
},
"LeaveDateTime": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The date and time when the participant leaves the video call."
},
"Name": {
"type": "string",
"properties": "Filter, Group, idLookup, Nillable, Sort",
"description": "The participant's name or phone number. This information is provided by the video call provider."
},
"ParticipantType": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The role of the participant in the video call. Available in API version 65.0 and later. Possible values are: Attendee Organizer"
},
"RelatedPersonId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The Salesforce ID of the user, lead, or contact record for this participant. This is a polymorphic relationship field.",
"relationship_name": "RelatedPerson",
"relationship_type": "Lookup",
"refers_to": "Contact, Lead, User"
},
"VideoCallId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the video call record. This is a relationship field.",
"relationship_name": "VideoCall",
"relationship_type": "Lookup",
"refers_to": "VideoCall"
}
},
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **VideoCallParticipantChangeEvent (API version 55.0)**: Change events are available for the object.",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Email": {
"field_label": "Email",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Video Call Participant ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"ParticipantType": {
"field_label": "Participant Type",
"type": "picklist",
"length": "255"
},
"RelatedPersonId": {
"field_label": "Related Person ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"VideoCallId": {
"field_label": "Video Call ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}