mediatype.create

Opis

object mediatype.create(object/array mediaTypes)

Ta metoda pozwala na tworzenie nowych typów mediów.

Ta metoda jest dostępna tylko dla typu użytkownika Super admin. Uprawnienia do wywołania metody można cofnąć w ustawieniach ról użytkownika. Zobacz Role użytkowników aby uzyskać więcej informacji.

Parametry

(object/array) Typy mediów do utworzenia.

Oprócz standardowych właściwości typu mediów, metoda akceptuje następujące parametry.

Parametr Typ Opis
parameters array Parametry webhooka do utworzenia dla typu mediów.
message_templates array Szkice wiadomości do utworzenia dla typu mediów.

Zwracane wartości

(object) Zwraca obiekt zawierający identyfikatory utworzonych typów mediów we właściwości mediatypeids. Kolejność zwróconych identyfikatorów odpowiada kolejności przekazanych typów mediów.

Przykłady

Tworzenie typu mediów e-mail

Utwórz nowy typ mediów e-mail z niestandardowym portem SMTP oraz szkicami wiadomości.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "mediatype.create",
           "params": {
               "type": "0",
               "name": "E-mail",
               "smtp_server": "mail.example.com",
               "smtp_helo": "example.com",
               "smtp_email": "zabbix@example.com",
               "smtp_port": "587",
               "content_type": "1",
               "message_templates": [
                   {
                       "eventsource": "0",
                       "recovery": "0",
                       "subject": "Problem: {EVENT.NAME}",
                       "message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" started at {EVENT.TIME}."
                   },
                   {
                       "eventsource": "0",
                       "recovery": "1",
                       "subject": "Resolved in {EVENT.DURATION}: {EVENT.NAME}",
                       "message": "Problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}."
                   },
                   {
                       "eventsource": "0",
                       "recovery": "2",
                       "subject": "Updated problem in {EVENT.AGE}: {EVENT.NAME}",
                       "message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem \"{EVENT.NAME}\" on host \"{HOST.NAME}\" at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}."
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }
Copy
✔ Copied

Odpowiedź:

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

Tworzenie typu mediów - skrypt

Utwórz nowy typ mediów - skrypt z niestandardową wartością liczby prób oraz interwałem między nimi.

Zapytanie:

{
           "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
       }
Copy
✔ Copied

Odpowiedź:

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

Tworzenie typu mediów - webhook

Utwórz nowy typ mediów - webhook.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "mediatype.create",
           "params": {
               "type": "4",
               "name": "Webhook",
               "script": "var Webhook = {\r\n    token: null,\r\n    to: null,\r\n    subject: null,\r\n    message: null,\r\n\r\n    sendMessage: function() {\r\n        // some logic\r\n    }\r\n}",
               "parameters": [
                   {
                       "name": "Message",
                       "value": "{ALERT.MESSAGE}"
                   },
                   {
                       "name": "Subject",
                       "value": "{ALERT.SUBJECT}"
                   },
                   {
                       "name": "To",
                       "value": "{ALERT.SENDTO}"
                   },
                   {
                       "name": "Token",
                       "value": "<Token>"
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }
Copy
✔ Copied

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "9"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Źródło

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.