mailkit.journeys.trigger

Funkce mailkit.journeys.trigger vloží příjemce do scénáře.

Příjemce může být pomocí API volání vložen do nódu ON EVENT nebo do nodu WAIT, kde může být díky tomuto volání zkráceno čekání příjemce a příjemce nód opustí okamžitě do úspěšném API volání.

Ukázka API volání:

JSON 

{
   "function": "mailkit.journeys.trigger",
   "id": 12345678,
   "md5": "abc123def456abc123def456abc12345",
   "parameters": {
       "email": "example@example.com",
       "event_tag": "my_event",
       "event_data": {
            "name" : "content1",
            "other_name" : "content2"
        } 
    }
}

XML 

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.journeys.trigger</methodName>
  <params>
    <param>
      <value><int>123456789</int></value>
    </param>
    <param>
      <value><string>abc123def456abc123def456abc12345</string></value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>email</name>
            <value><string>example@example.com</string></value>
          </member>
          <member>
            <name>event_tag</name>
            <value><string>my_event</string></value>
          </member>
          <member>
            <name>event_data</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value><string>content1</string></value>
                </member>
                <member>
                  <name>other_name</name>
                  <value><string>content2</string></value>
                </member>
              </struct>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

Hodnoty

client_id* = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5* = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
email* = e-mailová adresa příjemce, který:

  • má být vložen do scénáře (pomocí nodu ON EVENT)
  • má okamžitě opustit WAIT nod

event_tag* = název eventu, který je poté definován na nastavení nodů ON EVENT nebo WAIT
event_data = libovolná data, která mohou být v rámci eventu ve scénáři dále zpracována

* povinný parametr

Po úspěšném volání se vrací:

JSON 

{
   "message": "Added into scenario",
   "error_status": 0,
   "status": "OK"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>message</name>
                        <value>
                            <string>Added into scenario events queue</string>
                        </value>
                    </member>
                    <member>
                        <name>status</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                    <member>
                        <name>error_status</name>
                        <value>
                            <i4>0</i4>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

Po neúspěšném volání se vrací:

JSON 

{
    "error": "Missing event_tag",
    "error_status": 1
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Missing event_tag</string>
            </value>
        </param>
    </params>
</methodResponse>

Hodnoty

Missing event_tag = chybějící event tag
Missing email = chybějící e-mail