Transacional — Nó de Automação¶

Os nós são os passos de uma automação. Cada nó tem um type, um child (o nó seguinte, ou null quando o contacto sai do fluxo) e, nos nós ifElse e externalEvent, um child2 (o segundo ramo). As definições de um nó ficam em payload e são alteradas com um PUT próprio de cada tipo.

Endpoints¶

Os nós são lidos com GET /transactional/<transactional>/automation/<automation>. Envie os parâmetros form-encoded ou na query string.

Tipos de nó¶

POST /transactional/<transactional>/automation/<automation>/node¶

Cria um nó e liga-o ao fluxo.

• Os tipos de entrada (contactSignup, contactAnniversary, externalEventEntry, smsReceivedEntry) têm de ser criados com connectFrom=null&connectTo=null, e os outros tipos não. Caso contrário, o pedido falha com Incompatible type and position.
• Um novo nó de entrada leva ao mesmo primeiro passo dos nós de entrada existentes.
• Para acrescentar um nó entre dois nós, indique em connectTo o nó seguinte. Com connectTo=null, ligue apenas a um nó ou ramo que ainda não tenha nó seguinte.

Devolve: O novo nó (transactionalAutomationNode) e a automação.

Exemplo — acrescentar um nó sendMessage depois do nó 31:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "type=sendMessage&connectFrom=31&connectTo=null" \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node

Resposta:

{
  "success": true,
  "data": {
    "transactionalAutomation": {
      "id": 7,
      "name": "Payment follow-up",
      "enabled": false,
      "send_transactional": 1
    },
    "transactionalAutomationNode": {
      "id": 32,
      "send_transactional_automation": 7,
      "type": "sendMessage",
      "title": "Receives a message",
      "comment": "Click to select message",
      "child": null,
      "child2": null,
      "payload": null
    }
  }
}

PUT /transactional/<transactional>/automation/<automation>/node/<node>/<type>¶

Altera as definições do nó. <type> tem de ser o tipo do nó. Envie um POST com x-verb=PUT. Cada pedido substitui o payload inteiro.

Devolve: transactional, transactionalAutomation e o transactionalAutomationNode atualizado, com o seu payload e um novo comment.

contactSignup¶

Payload: {"segment": 5}

contactAnniversary¶

Payload: {"field_to_check": 42, "check_period": "year"}

externalEventEntry¶

Payload: {"event": "payment", "fields_to_set": []}

externalEvent¶

Os parâmetros de externalEventEntry e ainda:

Defina um tempo limite só quando precisar do segundo ramo.

wait¶

Payload: {"period": 86400}

sendMessage¶

Payload: {"message": 12}. O contacto recebe o email da mensagem se tiver endereço de email, e o seu SMS se tiver número de telefone. Os contactos não subscritos ou com bounce não recebem nada, mas continuam no fluxo.

setField¶

Payload: {"fields_to_set": {"VIP": "43"}} (valor → ID do campo). Cada valor só pode ser usado uma vez por nó: para gravar o mesmo valor em dois campos, use dois nós setField.

ifElse¶

Payload: {"topoperator": "AND", "operands": [{"field": "45", "operator": "==", "operand": "yes"}]}. Verdadeiro → child, falso → child2.

httpCallback¶

Envie os quatro arrays parameter…[] com uma entrada por parâmetro, com valores vazios onde não se aplicam. Um parâmetro com nome vazio é ignorado.

Payload: {"url": "https://example.com/duo/hook", "http_error": null, "http_result": 44, "http_parameters": [{"name": "email", "source": "field", "fieldValue": "email"}, {"name": "token", "source": "static", "staticValue": "s3cr3t"}]}

O pedido que a DUO faz: POST <url> com Content-Type: application/x-www-form-urlencoded e os parâmetros como campos do corpo (sem corpo se não houver nenhum), User-Agent: duo/<versão> e tempo limite de 60 segundos. Uma resposta 2xx faz o contacto seguir para child. Com qualquer outra resposta, ou se o pedido falhar, o contacto não continua, exceto se http_error estiver definido. Os pedidos não são assinados nem repetidos: coloque um token secreto num parâmetro static e verifique-o do seu lado.

Exemplo — configurar um nó httpCallback:

curl -u "username:api_key" -H "Accept: application/json" \
  --data-urlencode "x-verb=PUT" \
  --data-urlencode "url=https://example.com/duo/hook" \
  --data-urlencode "parameterName[]=email" --data-urlencode "parameterSource[]=field" \
  --data-urlencode "parameterStaticValue[]=" --data-urlencode "parameterFieldValue[]=email" \
  --data-urlencode "parameterName[]=token" --data-urlencode "parameterSource[]=static" \
  --data-urlencode "parameterStaticValue[]=s3cr3t" --data-urlencode "parameterFieldValue[]=" \
  --data-urlencode "http_error=" --data-urlencode "http_result=" \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node/{node_id}/httpCallback

smsReceivedEntry, smsReceived¶

Payload: {"inbound_telephone": null, "set_field": {"field": 45, "source": "regex", "regex": "^SIM (\\d+)"}, "timeout": 3600}

DELETE /transactional/<transactional>/automation/<automation>/node/<node>¶

Elimina o nó. Os nós que apontavam para ele passam a apontar para o seu child. Eliminar um nó ifElse ou externalEvent elimina também o primeiro nó do seu segundo ramo: elimine primeiro os nós desse ramo, do último para o primeiro.

Devolve: transactional, transactionalAutomation e o transactionalAutomationNode eliminado.

Exemplo:

curl -u "username:api_key" -H "Accept: application/json" -X DELETE \
  https://app.duo.pt/transactional/{transactional_id}/automation/{automation_id}/node/{node_id}