Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Media

Medias.update

Modifies Media or Medias with given id(s)

patch/entities/Medias/{id}

Path parameters

idstring uuid required

ID of Media to update

Query parameters

validation-levelinteger

Specify validation level of Media on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

activity_idstring uuid

Id of the linked appointment or task, or empty when not linked to an activity.

call_idstring uuid

Id of the linked call, or empty when not linked.

dataobject

Provider-specific metadata about the media (e.g. transcription identifiers, recording parameters), as a JSON object.

descriptionstring

Free-text description of the media.

error_codeinteger

Error code reported by the calling/recording provider when processing failed; empty on success.

status1 | 2 | 3 | 4 | 5 | 6

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - NoRecording, 2 - Uploading, 3 - Uploaded, 4 - Transcoding, 5 - TranscriptionInProgress, 6 - TranscriptionCompleted

type1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Audio, 2 - Video, 3 - Transcription

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "activity_id": "01234567-abcd-dcba-ffff-000000000000",
  "call_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "error_code": 1,
  "status": 1,
  "type": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting Media

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "call_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "error_code": 1,
    "status": 1,
    "type": 1,
    "revision": 1,
    "audio_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_file_id": "01234567-abcd-dcba-ffff-000000000000",
    "transcription_id": "string",
    "transcription_language": "string",
    "transcription_summary": "string",
    "get_transcription_viewer_token": "string"
  }
}