Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Dentro del Workflow Designer se encuentran las actividades que permiten crear proveedores y webhooks para uContact.

Note

Los flujos de proveedores y webhooks poseen algunas de las actividades detalladas en los bots, más un par de actividades extras exclusivas para su desarrollo, las mismas serán explicadas en cada caso de uso.

Contenido

Table of Contents
Tip

Una vez que se coloque la start activity deseada, se desplegarán las actividades relacionadas con su canal y necesarias para la creación del flujo.

Info

Para ver más sobre las actividades, ir a https://integra-scm.atlassian.net/wiki/spaces/UVE/pages/2398715907/Actividades+del+Dise+ador+de+flujos#WebhookStartActivity,-ChannelProviderStartActivity-y-BlacklistStartActivity

ChannelProviderStartActivity

Variables disponibles

  • AGENT
    Nombre del agente si hay interacción.

  • MESSAGE
    Mensaje.

  • TO
    Número destinatario.

  • ATTACHMENTS
    Array de objetos, cada uno conteniendo un attachment.

    Code Block
    languagejson
    [
      {
        "extension":"png",
        "path":"20210226/8b5eb91a-2799-4c30-a712-9cfbbd333f49.1584030188436.png",
        "url":"https://example.ucontactcloud.com/attachments/20210226/8b5eb91a-2799-4c30-a712-9cfbbd333f49.1584030188436.png",
        "type":"image/png"
      }
    ]
  • CAMPAIGN
    Campaña de la interacción.

  • GUID
    GUID de la interacción.

  • SMS_GUID
    GUID único del mensaje.

Tip

Para crear un proveedor personalizado, lo más común es que se use la aplicación ExecWebService.

WebhookStartActivity

...

Para llamar al webhook se debe realizar una request del siguiente tipo con los métodos GET POST PUT o DELETE.

...

uContact permite la creación de webhooks entrantes para poder realizar acciones personalizadas cuando se ejecuten mediante llamadas HTTP el Webhook específico. Se pueden crear tantos webhooks como se deseen y cada uno se ejecuta llamando a una ruta específica. A su vez, es posible devolver un resultado personalizado, tanto el código de respuesta, cuerpo y headers.

Los Webhooks se crean utilizando el diseñador de flujos de uContact y cada uno tiene un nombre único. Los mismos van a ser ejecutados al realizar una llamada de tipo GET, POST, PUT o DELETE a una ruta en específico. Solo es posible recibir peticiones de tipo “application/json” y “application/x-www-form-urlencoded”.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#DEEBFF

https://<instancia>.ucontactcloud.com/IntegraChannels/resources/

...

<nombre del webhook>

Variables disponibles

METHOD

...

type: String

...

Al ejecutar un flujo de webhook se setean variables globales disponibles disponibles desde javascript que contienen la información de la petición: método, body y headers.

METHOD

El método HTTP de ejecución de la petición. Los valores pueden ser GET, POST, PUT, DELETE

  • type: String

BODY

type: Object

Info

En caso de que la request

...

sea del tipo application/json

...

BODY

...

...

example:

Code Block
{ "name": "Daniel", "age": 23 }

FORM_PARAMS

Info

En caso de que la request

...

sea del tipo application/x-www-form-urlencoded

...

  • type:

...

  • Object

...

example:

Code Block
{ "param1": "param1", "param2": "param2" }

HEADERS

  • type:

...

  • Object

...

example:

Code Block
{
	"Accept"

...

: 
		"/"
	],
	"Cache-Control"

...

: 
		"no-cache"
	],
	"Connection"

...

: 
		"close"
	],
	"User-Agent"

...

:
		"PostmanRuntime/7.26.8"
	]
}
  • Pueden ser: sent, delivered, read, error, invalid_session e invalid_number.

QUERY_PARAMS

Parámetros pasados por la URL del webhook, los mismos son clave - valor.

...

  • type: Obj

Ejemplo para la solicitud https://(Instancia).ucontactcloud.com/IntegraChannels/resources/webhook/

...

test?

...

phone=123123&

...

name=John

...

Ejemplo:

...

Code Block
{
  "

...

phone":"123123",
  "

...

name":"John"
}

Acciones disponibles

Se pueden ejecutar todas las acciones disponibles en forma de actividades en el diseñador, consultas a la base de datos, ejecución de métodos de la API de uContact, inyección de mensajes entrantes y ejecución de javascript.

Respuesta

Si no se utiliza la actividad SetWebhookResponse en el flujo de webhook, por defecto la respuesta será 200 con el body vació. En cambio al utilizarla se puede tener total control de la respuesta producida.