Sidebar

fr:manual:api:reference:mediatype:create

mediatype.create

Description

object mediatype.create(object/array mediaTypes)

Cette méthode permet de créer de nouveaux types de média.

Paramètres

(object/array) Types de média à créer.

Cette méthode accepte les types de média avec les propriétés de l'objet type de média standard.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des types de média créés sous la propriété mediatypeids. L'ordre des ID retournés correspond à l'ordre des types de média transmis.

Exemples

Création d'un type de média

Créer un nouveau type de média email.

Requête :

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

Réponse :

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

Création d'un type de média avec des options personnalisées

Créez un nouveau type de média script avec une valeur personnalisée pour le nombre de tentatives et leur intervalle.

Requête :

{
    "jsonrpc": "2.0",
    "method": "mediatype.create",
    "params": {
        "type": 1,
        "description": "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
}

Réponse :

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

Source

CMediaType::create() dans frontends/php/include/classes/api/services/CMediaType.php.