Methods

Objects

media/recording

Media recordings

Method	Description
media/recording.create_from_realtime_record	Creates a Media recording object from a recording previously created u...
media/recording.delete	Delete recordings
media/recording.delete_all	Delete recordings by type
media/recording.get	Get a recording
media/recording.get_list	Get recordings
media/recording.get_live	Get recordings currently recording
media/recording.get_read_status	Get read status by type
media/recording.mark_all_as_read	Mark all recordings as read
media/recording.mark_all_as_unread	Mark all recordings as unread
media/recording.mark_as_read	Mark recordings as read
media/recording.mark_as_unread	Mark recordings as unread
media/recording.overview	Get an overview of your recordings
media/recording.search	Search through your Media recordings.

Methods

media/recording.create_from_realtime_record

Description

Creates a Media recording object from a recording previously created using the REAL-TIME command "record". Warning: Temporary recording files are kept only for 30 minutes after the call ended.

Signature

method: media/recording.create_from_realtime_record

params: [string media_file, object options]

Parameters

Parameter	Type	Description	NULL
media_file	string	Recording file (see the REAL-TIME "record" command).	NO
options	object	Media.Recording Options. Send NULL to use default values. Object: Media.Recording.Options	YES

Result

Type	Description	Format/Object
object	Recording	Object: Media.Recording

media/recording.delete

Description

Delete recordings

Signature

method: media/recording.delete

params: [array hash_list]

Parameters

Parameter	Type	Description	NULL
hash_list	array	Recording IDs Format: hash (Unique object identifier)	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.delete_all

Description

Delete recordings by type

Signature

method: media/recording.delete_all

params: [string type]

Parameters

Parameter	Type	Description	NULL
type	string	Recording type Values: "CALL", "RECORDING", "VOICEMAIL"	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.get

Description

Get a recording

Signature

method: media/recording.get

params: [string recording_hash]

Parameters

Parameter	Type	Description	NULL
recording_hash	string	Recording ID	NO

Result

Type	Description	Format/Object
object	Recording	Object: Media.Recording

media/recording.get_list

Description

Get recordings

Signature

method: media/recording.get_list

params: [string type, bool read, int offset, int quantity]

Parameters

Parameter	Type	Description	NULL
type	string	Recording type Values: "CALL", "RECORDING", "VOICEMAIL"	NO
read	bool	Read status (send NULL to ignore)	NO
offset	int	List index (zero-based).	NO
quantity	int	Max quantity returned.	NO

Result

Type	Description	Format/Object
object	Recordings results	Object: Media.Recording.ListResult

media/recording.get_live

Description

Get recordings currently recording

Signature

method: media/recording.get_live

params: [string type, int offset, int quantity]

Parameters

Parameter	Type	Description	NULL
type	string	Recording type Values: "CALL", "RECORDING", "VOICEMAIL"	NO
offset	int	List index (zero-based).	NO
quantity	int	Max quantity returned.	NO

Result

Type	Description	Format/Object
object	Live recordings results	Object: Media.Recording.ListResult

media/recording.get_read_status

Description

Get read status by type

Signature

method: media/recording.get_read_status

params: []

Parameters

No parameters.

Result

Type	Description	Format/Object
object	Read status by type	Object: Media.Recording.ReadStatus

media/recording.mark_all_as_read

Description

Mark all recordings as read

Signature

method: media/recording.mark_all_as_read

params: [string type]

Parameters

Parameter	Type	Description	NULL
type	string	Recording type Values: "CALL", "RECORDING", "VOICEMAIL"	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.mark_all_as_unread

Description

Mark all recordings as unread

Signature

method: media/recording.mark_all_as_unread

params: [string type]

Parameters

Parameter	Type	Description	NULL
type	string	Recording type Values: "CALL", "RECORDING", "VOICEMAIL"	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.mark_as_read

Description

Mark recordings as read

Signature

method: media/recording.mark_as_read

params: [array hash_list]

Parameters

Parameter	Type	Description	NULL
hash_list	array	Recording IDs Format: hash (Unique object identifier)	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.mark_as_unread

Description

Mark recordings as unread

Signature

method: media/recording.mark_as_unread

params: [array hash_list]

Parameters

Parameter	Type	Description	NULL
hash_list	array	Recording IDs Format: hash (Unique object identifier)	NO

Result

Type	Description	Format/Object
object	Action result	Object: Media.Recording.ActionResult

media/recording.overview

Description

Get an overview of your recordings

Signature

method: media/recording.overview

params: []

Parameters

No parameters.

Result

Type	Description	Format/Object
object	Overview	Object: Media.Recording.Overview

media/recording.search

Description

Search through your Media recordings.

Signature

method: media/recording.search

params: [object filters, object options]

Parameters

Parameter	Type	Description	NULL
filters	object	Search filters Object: Media.Recording.SearchFilters	NO
options	object	Search options Object: Search.Options	NO

Result

Type	Description	Format/Object
object	Search results	Object: Search.Results