OBJECT

MediaEntity

Recording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment.

link GraphQL Schema definition

  • type MediaEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Appointment this media is attached to. Set when activityId resolves to an
  • # Appointment.
  • appointment: AppointmentEntity
  • # Task this media is attached to. Set when activityId resolves to a Task.
  • task: TaskEntity
  • # Call this media belongs to (e.g. a recording or transcription).
  • call: CallEntity
  • # Id of the linked appointment or task, or empty when not linked to an activity.
  • activityId: ID
  • # Id of the linked call, or empty when not linked.
  • callId: ID
  • # Provider-specific metadata about the media (e.g. transcription identifiers,
  • # recording parameters), as a JSON object.
  • data: JSONString
  • # Free-text description of the media.
  • description: String
  • # Error code reported by the calling/recording provider when processing failed;
  • # empty on success.
  • errorCode: Int
  • # Processing stage of the recording and its transcription, from upload through
  • # transcoding to transcription. TranscriptionCompleted is also set when
  • # transcription failed; check errorCode.
  • status: MediaStatusEnum
  • # Kind of media. Recordings created by the application, uploaded or from calls,
  • # are Transcription: an audio or video recording transcribed to text; Audio and
  • # Video are currently not set.
  • type: MediaTypeEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Id of the cloud object holding the audio recording, when available.
  • audioId: UUID
  • # Id of the cloud object holding the transcription payload, when available.
  • transcriptionFileId: UUID
  • # External transcription identifier from the calling provider.
  • transcriptionId: String
  • # Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US",
  • # "de-DE"). Set when the transcription was requested.
  • transcriptionLanguage: String
  • # AI-generated summary of the transcription content.
  • transcriptionSummary: String
  • # Short-lived token for opening the transcription in the calling provider's
  • # viewer. Empty when no transcription is available.
  • getTranscriptionViewerToken: String!
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Audio recording (MP3 file) of the media or of the call it belongs to; empty when
  • # none is stored.
  • audio: CloudObjectEntity
  • # Transcription (JSON file) of the media or of the call it belongs to; empty when
  • # none is stored.
  • transcriptionFile: CloudObjectEntity
  • }

link Require by