Table of Contents
usermedia.get
Description
integer/array usermedia.get(object parameters)
The method allows to retrieve media according to the given parameters.
This method is deprecated and will be removed in the future. Please use user.get instead.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| mediaids | string/array | Return only media with the given IDs. |
| usrgrpids | string/array | Return only media that are used by users in the given user groups. |
| userids | string/array | Return only media that are used by the given users. |
| mediatypeids | string/array | Return only media that use the given media types. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: mediaid, userid and mediatypeid. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Examples
Retrieving media by user
Retrieve all media for the given user.
Request:
{
"jsonrpc": "2.0",
"method": "usermedia.get",
"params": {
"output": "extend",
"userids": "1"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"mediaid": "8",
"userid": "1",
"mediatypeid": "3",
"sendto": "+3711231233",
"active": "0",
"severity": "48",
"period": "1-5,09:00-18:00"
},
{
"mediaid": "9",
"userid": "1",
"mediatypeid": "1",
"sendto": "[email protected]",
"active": "0",
"severity": "63",
"period": "1-7,00:00-24:00"
}
],
"id": 1
}Source
CUserMedia::get() in frontends/php/include/classes/api/services/CUserMedia.php.