COcoevera
Media

Medias.batch_create_or_update

Creates or updates Media records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/Medias/batch-modify

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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

Processing stage of the recording and its transcription, from upload through transcoding to transcription. TranscriptionCompleted is also set when transcription failed; check error_code.

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

type1 | 2 | 3

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.

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

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.