You are viewing the Spanish (Mexico) site, but your language preference is set to English. Switch to English site →

Menu

Expand
Calificar esta página:

Recurso de flujo de Flex

Actualmente estás leyendo documentación de mensajería antigua de Flex. Si estás empezando con una nueva implementación de Flex, considera la posibilidad de utilizar Flex Conversations.

Un flujo de Flex es la lógica que vincula una identidad de contacto (por ejemplo, número de teléfono habilitado para SMS o número fr WhatsApp) a Flex.

En esta página, se detalla el recurso de API de flujo de Flex. Consulta la documentación adicional para obtener más información sobre cómo trabajar con flujos de Flex.

Propiedades de FlexFlow

Resource Properties in REST API format
account_sid
sid<AC> Not PII

El SID de la [Account] (Cuenta) (https://www.twilio.com/docs/iam/api/account) que creó el recurso del flujo de Flex y posee este flujo de trabajo.

date_created
date_time<iso8601> Not PII

La fecha y hora en GMT en que se creó el recurso, especificadas en formato ISO 8601.

date_updated
date_time<iso8601> Not PII

La fecha y hora en GMT en que se actualizó el recurso por última vez, especificadas en formato ISO 8601.

sid
sid<FO> Not PII

La cadena única que creamos para identificar el recurso del flujo de Flex.

friendly_name

La cadena que asignó para describir el recurso.

chat_service_sid
sid<IS> Not PII

El SID del servicio de chat.

channel_type
enum:channel_type Not PII

El tipo de canal. Uno de “web”, “facebook”, “sms”, “whatsapp”, “line” o “personalizado”. De forma predeterminada, el widget Send to Flex (Enviar a Flex) de Studio lo pasa a los atributos de tarea de las tareas creadas según este flujo de Flex. Flex UI (la interfaz de usuario de Flex) utilizará los atributos de tarea para mostrar la tarea respectiva según corresponda (aplicando límites de diseño y longitud específicos del canal). Si “channelType” (Tipo de canal) es “facebook”, “whatsapp” o “line”, el widget Send to Flex (Enviar a Flex) debería establecer el canal de tareas en Programmable Chat.

contact_identity
string Not PII

La identidad del contacto del canal.

enabled
boolean Not PII

Si el flujo de Flex está habilitado.

integration_type
enum:integration_type Not PII

El software que gestionará los mensajes entrantes. El [Integration Type] (Tipo de integración) (https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) puede ser: “studio”, “external” (externo) o “task” (tarea).

integration
object Not PII

Un objeto que contiene parámetros específicos para la integración.

long_lived
boolean Not PII

Cuando se habilita, Flex mantendrá activo el canal de chat para que pueda utilizarse en interacciones posteriores con una identidad de contacto. Por defecto es “false”.

janitor_enabled
boolean Not PII

Cuando se habilita, el encargado de mensajería del canal quitará las sesiones de proxy activas si la tarea asociada se elimina fuera de Flex UI (la interfaz de usuario de Flex). Por defecto es “false”.

url
url Not PII

La URL absoluta del recurso del flujo de Flex.

Crear un recurso de FlexFlow

post
https://flex-api.twilio.com/v1/FlexFlows
Parameters
Parameters in REST API format
friendly_name
Required
post string PII MTL: 30 DAYS

Una cadena descriptiva que creas para describir el recurso del flujo de Flex.

chat_service_sid
Required
post sid<IS> Not PII

El SID del servicio de chat.

channel_type
Required
post ienum:channel_type Not PII

El tipo de canal. Uno de “web”, “facebook”, “sms”, “whatsapp”, “line” o “personalizado”. De forma predeterminada, el widget Send to Flex (Enviar a Flex) de Studio lo pasa a los atributos de tarea de las tareas creadas según este flujo de Flex. Flex UI (la interfaz de usuario de Flex) utilizará los atributos de tarea para mostrar la tarea respectiva según corresponda (aplicando límites de diseño y longitud específicos del canal). Si “channelType” (Tipo de canal) es “facebook”, “whatsapp” o “line”, el widget Send to Flex (Enviar a Flex) debería establecer el canal de tareas en Programmable Chat.

contact_identity
Optional
post string Not PII

La identidad del contacto del canal.

enabled
Optional
post boolean Not PII

Si el nuevo flujo de Flex está habilitado.

integration_type
Optional
post ienum:integration_type Not PII

El software que gestionará los mensajes entrantes. El [Integration Type] (Tipo de integración) (https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) puede ser: “studio”, “external” o “task”.

integration.flow_sid
Optional
post sid<FW> Not PII

El SID del flujo de Studio. Requerido cuando “integrationType” es “studio”.

integration.url
Optional
post url Not PII

La URL del webhook externo. Requerido cuando “integrationType” es “external”.

integration.workspace_sid
Optional
post sid<WS> Not PII

El SID del espacio de trabajo para una nueva tarea. Requerido cuando “integrationType” es “”.

integration.workflow_sid
Optional
post sid<WW> Not PII

El SID del flujo de trabajo para una nueva tarea. Requerido cuando “integrationType” es “”.

integration.channel
Optional
post string Not PII

El SID del canal de tarea (TCXXXX) o nombre único (por ejemplo, “sms”) que se va a utilizar para la tarea que se creará. Aplicable y requerido cuando “integrationType” es “task”. El valor predeterminado es “default”.

integration.timeout
Optional
post integer Not PII

El tiempo de espera de una tarea en segundos para una tarea nueva. El valor predeterminado es 86 400 segundos (24 horas). Es opcional cuando “integrationType” es “task”, de lo contrario no es aplicable.

integration.priority
Optional
post integer Not PII

La prioridad de tarea de una tarea nueva. La prioridad predeterminada es 0. Es opcional cuando “integrationType” es “task”, de lo contrario no es aplicable.

integration.creation_on_message
Optional
post boolean Not PII

En el contexto de la mensajería saliente, define si se debe crear una tarea inmediatamente (y, por lo tanto, reservar la conversación para el agente actual) o retrasar la creación de la tarea hasta que el cliente envíe la primera respuesta. Establece el valor en false para crearla inmediatamente y true para retrasar la creación de la tarea. Esta configuración solo se aplica a la mensajería saliente.

long_lived
Optional
post boolean Not PII

Cuando se habilita, Flex mantendrá activo el canal de chat para que pueda utilizarse en interacciones posteriores con una identidad de contacto. Por defecto es “false”.

janitor_enabled
Optional
post boolean Not PII

Cuando se habilita, el encargado de mensajería del canal quitará las sesiones de proxy activas si la tarea asociada se elimina fuera de Flex UI (la interfaz de usuario de Flex). Por defecto es “false”.

integration.retry_count
Optional
post integer Not PII

La cantidad de veces que se reintentará el webhook o el flujo de Studio en caso de una falla. Toma valores enteros de 0 a 3, siendo el valor predeterminado 3. Es opcional cuando “integrationType” es “studio” o “external”, de lo contrario no es aplicable.

Example 1
        
        
        
        Example 2
              
              
              

              La guía de uso de Studio es una introducción útil a los flujos de Studio y la idea general de cómo funciona Studio. Si buscas una forma sencilla de impulsar tu flujo de Flex, un flujo de Studio subyacente puede ser la forma correcta.

              Cuando recibes un mensaje entrante, el flujo de Flex realiza una solicitud POST que contiene el cuerpo del mensaje y algunos metadatos al webhook elegido.

                    
                    
                    

                    Obtener un recurso FlexFlow

                    get
                    https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    get sid<FO> Not PII

                    El SID del recurso del flujo de Flex que se obtendrá.

                    Example 1
                          
                          
                          

                          Leer varios recursos FlexFlow

                          get
                          https://flex-api.twilio.com/v1/FlexFlows
                          Parameters
                          Parameters in REST API format
                          friendly_name
                          Optional
                          get string PII MTL: 30 DAYS

                          El “friendly_name” (nombre_descriptivo) de los recursos del flujo de Flex que se van a leer.

                          Example 1
                                
                                
                                

                                Actualizar un recurso FlexFlow

                                post
                                https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                                Parameters
                                Parameters in REST API format
                                sid
                                Path
                                post sid<FO> Not PII

                                El SID del recurso del flujo de Flex que se actualizará.

                                friendly_name
                                Optional
                                post string PII MTL: 30 DAYS

                                Una cadena descriptiva que creas para describir el recurso del flujo de Flex.

                                chat_service_sid
                                Optional
                                post sid<IS> Not PII

                                El SID del servicio de chat.

                                channel_type
                                Optional
                                post ienum:channel_type Not PII

                                El tipo de canal. Uno de “web”, “facebook”, “sms”, “whatsapp”, “line” o “personalizado”. De forma predeterminada, el widget Send to Flex (Enviar a Flex) de Studio lo pasa a los atributos de tarea de las tareas creadas según este flujo de Flex. Flex UI (la interfaz de usuario de Flex) utilizará los atributos de tarea para mostrar la tarea respectiva según corresponda (aplicando límites de diseño y longitud específicos del canal). Si “channelType” (Tipo de canal) es “facebook”, “whatsapp” o “line”, el widget Send to Flex (Enviar a Flex) debería establecer el canal de tareas en Programmable Chat.

                                contact_identity
                                Optional
                                post string Not PII

                                La identidad del contacto del canal.

                                enabled
                                Optional
                                post boolean Not PII

                                Si el nuevo flujo de Flex está habilitado.

                                integration_type
                                Optional
                                post ienum:integration_type Not PII

                                El software que gestionará los mensajes entrantes. El [Integration Type] (Tipo de integración) (https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) puede ser: “studio”, “external” o “task”.

                                integration.flow_sid
                                Optional
                                post sid<FW> Not PII

                                El SID del flujo de Studio. Requerido cuando “integrationType” es “studio”.

                                integration.url
                                Optional
                                post url Not PII

                                La URL del webhook externo. Requerido cuando “integrationType” es “external”.

                                integration.workspace_sid
                                Optional
                                post sid<WS> Not PII

                                El SID del espacio de trabajo para una nueva tarea. Requerido cuando “integrationType” es “”.

                                integration.workflow_sid
                                Optional
                                post sid<WW> Not PII

                                El SID del flujo de trabajo para una nueva tarea. Requerido cuando “integrationType” es “”.

                                integration.channel
                                Optional
                                post string Not PII

                                El SID del canal de tarea (TCXXXX) o nombre único (por ejemplo, “sms”) que se va a utilizar para la tarea que se creará. Aplicable y requerido cuando “integrationType” es “task”. El valor predeterminado es “default”.

                                integration.timeout
                                Optional
                                post integer Not PII

                                El tiempo de espera de una tarea en segundos para una tarea nueva. El valor predeterminado es 86 400 segundos (24 horas). Es opcional cuando “integrationType” es “task”, de lo contrario no es aplicable.

                                integration.priority
                                Optional
                                post integer Not PII

                                La prioridad de tarea de una tarea nueva. La prioridad predeterminada es 0. Es opcional cuando “integrationType” es “task”, de lo contrario no es aplicable.

                                integration.creation_on_message
                                Optional
                                post boolean Not PII

                                En el contexto de la mensajería saliente, define si se debe crear una tarea inmediatamente (y, por lo tanto, reservar la conversación para el agente actual) o retrasar la creación de la tarea hasta que el cliente envíe la primera respuesta. Establece el valor en false para crearla inmediatamente y true para retrasar la creación de la tarea. Esta configuración solo se aplica a la mensajería saliente.

                                long_lived
                                Optional
                                post boolean Not PII

                                Cuando se habilita, Flex mantendrá activo el canal de chat para que pueda utilizarse en interacciones posteriores con una identidad de contacto. Por defecto es “false”.

                                janitor_enabled
                                Optional
                                post boolean Not PII

                                Cuando se habilita, el encargado de mensajería del canal quitará las sesiones de proxy activas si la tarea asociada se elimina fuera de Flex UI (la interfaz de usuario de Flex). Por defecto es “false”.

                                integration.retry_count
                                Optional
                                post integer Not PII

                                La cantidad de veces que se reintentará el webhook o el flujo de Studio en caso de una falla. Toma valores enteros de 0 a 3, siendo el valor predeterminado 3. Es opcional cuando “integrationType” es “studio” o “external”, de lo contrario no es aplicable.

                                Example 1
                                      
                                      
                                      

                                      Eliminar un flujo de Flex

                                      delete
                                      https://flex-api.twilio.com/v1/FlexFlows/{Sid}
                                      Parameters
                                      Parameters in REST API format
                                      sid
                                      Path
                                      delete sid<FO> Not PII

                                      El SID del recurso del flujo de Flex que se eliminará.

                                      Example 1
                                            
                                            
                                            
                                            Calificar esta página:

                                            ¿Necesitas ayuda?

                                            Todos la necesitamos a veces; la programación es difícil. Obtén ayuda ahora de nuestro equipo de soporte, o recurre a la sabiduría de la multitud visitando Stack Overflow Collective de Twilio o navegando por la etiqueta de Twilio en Stack Overflow.

                                                  
                                                  
                                                  

                                                  Gracias por tus comentarios.

                                                  Selecciona los motivos de tus comentarios. La información adicional que nos brindas nos ayuda a mejorar nuestra documentación:

                                                  Enviando tus comentarios…
                                                  🎉 Gracias por tus comentarios.
                                                  Se produjo un error. Inténtalo de nuevo.

                                                  Gracias por tus comentarios.

                                                  ¡Recomiéndanos y gana USD 10 en 3 pasos sencillos!

                                                  Paso 1

                                                  Obtén un enlace

                                                  Obtén un enlace gratuito de referencia personal aquí

                                                  Paso 2

                                                  Regala USD 10

                                                  Tu usuario se registra y actualiza mediante el enlace

                                                  Paso 3

                                                  Obtén USD 10

                                                  1250 SMS gratuitos
                                                  O 1000 minutos gratuitos de voz
                                                  O 12 000 chats
                                                  O más