Sidebar

manual:api:reference:mediatype:create

mediatype.create

Description

object mediatype.create(object/array mediaTypes)

This method allows to create new media types.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Media types to create.

The method accepts media types with the standard media type properties.

Return values

(object) Returns an object containing the IDs of the created media types under the mediatypeids property. The order of the returned IDs matches the order of the passed media types.

Examples

Creating a media type

Create a new e-mail media type.

Request:

{
    "jsonrpc": "2.0",
    "method": "mediatype.create",
    "params": {
        "name": "E-mail",
        "type": 0,
        "smtp_server": "[email protected]",
        "smtp_helo": "company.com",
        "smtp_email": "[email protected]",
        "content_type": 1
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "mediatypeids": [
            "7"
        ]
    },
    "id": 1
}

Creating a media type with custom options

Create a new script media type with custom value for number of attempts and interval between them.

Request:

{
    "jsonrpc": "2.0",
    "method": "mediatype.create",
    "params": {
        "type": 1,
        "name": "Push notifications",
        "exec_path": "push-notification.sh",
        "exec_params": "{ALERT.SENDTO}\n{ALERT.SUBJECT}\n{ALERT.MESSAGE}\n",
        "maxattempts": "5",
        "attempt_interval": "11s"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "mediatypeids": [
            "8"
        ]
    },
    "id": 1
}

Source

CMediaType::create() in ui/include/classes/api/services/CMediaType.php.