Medias.get

Returns Media with given id

Responses

🟢200OK

application/json

Media data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Media)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

appointment

string <uri>

optional

Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.

task

string <uri>

optional

Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties.

call

string <uri>

optional

Relation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties.

activity_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

call_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

data

object

optional

Field containing json.

description

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

status

enum<integer>

optional

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

Allowed values:

123456

Example:

type

enum<integer>

optional

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

Allowed values:

123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

audio_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

transcription_file_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

transcription_id

string

required

Example:

string

transcription_language

string

required

Example:

string

transcription_summary

string

required

Example:

string

get_transcription_viewer_token

string

required

Example:

string

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "appointment": "http://example.com",
        "task": "http://example.com",
        "call": "http://example.com",
        "activity_id": "01234567-abcd-dcba-ffff-000000000000",
        "call_id": "01234567-abcd-dcba-ffff-000000000000",
        "data": {},
        "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"
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses