Envío de Automated Notifications via flujo del Studio API

  1. Haga clic en Create flow en la página Flow Manager y de nuevo en la nueva ventana que aparece.
  2. Seleccione Empty flow [1] y luego haga clic en Next [2].

  1. Seleccione API request [3] y luego haga clic en Next [4].
  2. En la pantalla siguiente, introduzca un nombre y, si lo desea, una descripción para el flujo.

Ahora aparecerá la página del editor de flujos y verá el componente API request en la parte derecha. Dentro de ella, tendrá que configurar los argumentos de entrada, es decir, los datos que se enviarán en el cuerpo de la petición POST API que activará el flujo de studio. Cada argumento puede asignarse a una variable que puede utilizarse en el flujo.

Nota: Para más información sobre los argumentos en las Automated Notifications, visite esta sección.

  1. Rellene el primer cuadro de texto con "Argument name" - "contact[0]::name", que represente el nombre del contacto [5].
  2. Cree la variable correspondiente que se asignará al flujo "contact_name" [6].
  3. Si la variable no existe, puede crear una nueva haciendo clic en Create variable [7] e introduciendo el nombre deseado.
  4. Repita el proceso y seleccione Add new argument [8] para rellenar los argumentos necesarios para el caso de uso abordado por el flujo de studio que se está creando.

 

Arguments en las Automated Notifications

En el contexto de las Automated Notifications, los argumentos tienen que seguir la estructura del evento desencadenado por la Automated Notifications API. Como ejemplo, vea el siguiente objeto:

{

  “contacts[0]::name”:“John Doe”,

  “contacts[0]::preferred_channel”:“SMS”,

  “contacts[0]::channels[0]::type”:“SMS”,

  “contacts[0]::channels[0]::uri”:“+3519923456879”,

  “data::doctor”:“Jane Doe”,

  “data::appointment_date”:“May, 14th”,

  “data::appointment_hour”:“10 am”,

  “event_id”:“4190fc44-ecae-4ae8-904e-2b8b6937ce24",

  “rule_id”:“ec96252d-63b0-41a1-a8ac-5481ab30b5c0",

  “an_interaction_id”:“6408c2351c1e7d566d47ad0"

}

Para añadir nombres de argumentos, siga la estrategia de nomenclatura de las propiedades, por ejemplo, “contacts[0]::name” para el nombre de contacto y “an_interaction_id” para la interaction ID. Es necesario seguir esta estrategia de nomenclatura, de lo contrario, el flujo no podrá asignar los valores recibidos del evento a las variables de studio.

Nota: Si no conoce la estructura del evento, pero tiene acceso a la carga útil enviada al Automated Notifications API, debería ser similar al bloque de código siguiente:

{

    “external_id”: “external_id”,

    “correlation_id”:“acad2d2a-acd7-444d-9c58-636a8acd11ef”,

    “type”:“ANS_w_Interaction”,

    “source”:“source”,

    “contacts”:[

        {

            “name”: “John Doe”,

            “channels”: [

                {

                    “type”: “SMS”,

                    “uri”: “+3519923456789”

                }

            ],

            “preferred_channel”: “SMS”

        }

    ],

    “time_zone”:“+02:00",

    “primary_date”:“2023-03-09T09:44:00.777376Z”,

    “secondary_date”:“2021-06-24T16:00:00.777376Z”,

    “data”:{

        “doctor”: “Jane Doe”,

        “appointment_date”: “May, 14th”,

        “appointment_hour”: “10 am”

    }

}

La asignación de las variables puede deducirse a partir de ella, siguiendo algunas reglas:

 

Si está accediendo a un objeto

“data”:{

        “doctor”: “Jane Doe”,

        “appointment_date”: “May, 14th”,

        “appointment_hour”: “10 am”

    }

Navegue a la propiedad desde la raíz; por ejemplo, si desea el nombre del médico, se puede acceder navegando utilizando la siguiente convención: “data::doctor”. "::" le permite entrar al objeto. Si la propiedad está dentro de un objeto anidado, utilice"::" para navegar dentro de ese objeto.

 

Si está accediendo a una matriz

“contacts”:[

        {

            “name”: “John Doe”,

            “channels”: [

                {

                    “type”: “SMS”,

                    “uri”: “+3519923456789”

                }

            ],

            “preferred_channel”: “SMS”

        }

    ]

Al igual que en la navegación por objetos, puede ir dentro de la matriz utilizando"::" después del índice deseado (en base cero). Tomando el código anterior como ejemplo, suponiendo que quiera asignar la propiedad uri, navegue hasta ella como “contact[0]::channels[0]::uri”.

 

Si está accediendo a una propiedad directamente en la raíz

“an_interaction_id”:“6408c2351c1e7d566d47ad0"

Cuando la propiedad a asignar se encuentra en la raíz, para acceder a ella es necesario añadir el nombre de la propiedad (por ejemplo, “an_interaction_id”) en el nombre del argumento.

 

Nota: Tome los bloques de código anteriores como ejemplos, ya que tanto el evento como la carga útil pueden ser muy diferentes y tener más propiedades o, por el contrario, solo un par de ellas.

Volver ""
Por favor, inicie sesión para enviar una solicitud.